Get a list of all clients.

We created a new viewing experience for our SMS API documentation. It's now all in one central location. Click here to check it out!




pagePage number, for paginationNO
maxMaximum results returned per pageNO


curl \
  -u 2e24c1cbdd987221e165d543f34b84bf:secret

JSON Response

  clients_total: 24,
  clients: [
      id: 56423,
      name: "Terry's Repairs",
      contact: "Terry Richards",
      email: "",
      msisdn: "61491570156",
      currency: "AUD",
      timezone: "Australia/Sydney",
      created: "2013-02-14 13:45:22",
      client_pays: false,
      sms_margin: 3.1,
      apikey: "2e24xxxxxxxxxxxxxxxx4b84bf",
      apisecret: "YyYD2lad*88",
      recharge_amount: 20,
      total_lists: 34,
      total_sms: 575665,
      total_contacts: 542,
      total_spend: 450.464,
      total_revenue: 234.12,
      credits_based: false,
      balance: 43.56
    page: {
      count: 1,
      number: 1

XML Response

<?xml version="1.0" encoding="UTF-8"?>
    <name>Terry&amp;#39;s Repairs</name>
    <contact>Terry Richards</contact>
    <created>2013-02-14 13:45:22</created>

PHP Examples

  include '../../APIClient2.php';

  $api = new transmitsmsAPI('API_KEY', 'API_SECRET');
  $offset = 0;
  $limit = 10;

  $result = $api->getClients($offset,$limit);

  if ($result->error->code == 'SUCCESS') {
    echo "You have {$result->clients_total} clients, showing page
      {$result->page->number} of {$result->page->count} <hr>";

    foreach ($result->clientsas$client) {
      echo "Client {$client->name} with email {$client->email}
        has balance of {$client->balance}<br>";

  } else {
    echo "Error: {$result->error->description}";