Management (1.0.0)

Endpoints associated with creating and managing user accounts.

View Account Details

Get account information

Get account details

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/account

Request samples

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('USERNAME')
              ->setPassword('API_KEY');

$apiInstance = new ClickSend\Api\AccountApi(new GuzzleHttp\Client(),$config);

try {
    $result = $apiInstance->accountGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountGet: ', $e->getMessage(), PHP_EOL;
}
?>

Response samples

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here's your account.",
"data": {"user_id": 116,
"username": "johndoe1",
"user_email": "johndoe1@awesome.com",
"active": 0,
"banned": 0,
"balance": "4.998000",
"user_phone": "+15184811001",
"reply_to": "originalemail",
"delivery_to": null,
"user_first_name": "John",
"user_last_name": "Doe",
"account": 0,
"account_name": "The Awesome Company",
"account_billing_email": "johndoe1@awesome.com",
"account_billing_mobile": "+15184811001",
"country": "US",
"default_country_sms": "US",
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"low_credit_amount": "0.00",
"setting_unicode_sms": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 6,
"old_dashboard": 0,
"balance_commission": 0.299954,
"timezone": "Australia/Melbourne",
"_currency": {"currency_name_short": "AUD",
"currency_prefix_d": "$",
"currency_prefix_c": "c",
"currency_name_long": "Australian Dollars"
},
"_subaccount": {"subaccount_id": 126,
"api_username": "johndoe1",
"email": "johndoe1@awesome.com",
"phone_number": "+15184811001",
"first_name": "John",
"last_name": "Doe",
"api_key": "F3702045-EB2C-0091-C211-7728048DCAE2",
"access_users": 1,
"access_billing": 1,
"access_reporting": 1,
"access_contacts": 1,
"access_settings": 1,
"access_sms": 1,
"access_email": 1,
"access_voice": 1,
"access_fax": 1,
"access_post": 1,
"access_reseller": 1,
"access_mms": 1,
"share_campaigns": 0,
"notes": null
}
}
}

View Account Usage

Get account usage

Get account usage statistics grouped by subaccount.

Properties

Name	Type	Required	Restrictions	Description
year	string	true	none	Your account usage year. Example: 2019
month	string	true	none	Your account usage month. Example: 4