API:getClients - Get clients list

Get list of all clients. List is divided into pages, size of which is changeable in HostBill configuration section

Optional parameters

page

Which page to return

Request

GET http://url_to_your_hostbill.com/admin/api.php?api_id=API_ID&api_key=API_KEY&call=getClients

<?php
   include 'class.hbwrapper.php';
   HBWrapper::setAPI('http://url_to_hb.com/admin/api.php','API ID','API Key');
   $return = HBWrapper::singleton()->getClients();
   print_r($return);
?>

<?php
   $url = 'http://url_to_hb.com/admin/api.php';
   $post = array(
      'api_id' => API_ID,
      'api_key' => API_Key,
      'call' => 'getClients',
   );
   $ch = curl_init();
   curl_setopt($ch, CURLOPT_URL, $url);
   curl_setopt($ch, CURLOPT_POST, 1);
   curl_setopt($ch, CURLOPT_TIMEOUT, 30);
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
   curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
   curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
   $data = curl_exec($ch);
   curl_close($ch);
  
   $return = json_decode($data, true);
   print_r($return);
?>

<?php
   /* Use this method to access HostBill api from HostBill modules */
   $api = new ApiWrapper();
   $return = $api->getClients();
   print_r($return);
?>

Response

   {
      "success": true,
      "clients": [
         {
            "id": "8",
            "firstname": "Jack",
            "lastname": "Black",
            "datecreated": "2011-11-12",
            "email": "[email protected]",
            "companyname": "",
            "services": 2
         },
         {
            "id": "6",
            "firstname": "Mike",
            "lastname": "Blue",
            "datecreated": "2011-11-12",
            "email": "[email protected]",
            "companyname": "",
            "services": 3
         },
         {
            "id": "4",
            "firstname": "Jonah",
            "lastname": "Hamon",
            "datecreated": "2011-10-28",
            "email": "[email protected]",
            "companyname": "",
            "services": 8
         },
         {
            "id": "3",
            "firstname": "Administrator",
            "lastname": "Hostbill",
            "datecreated": "2011-10-28",
            "email": "[email protected]",
            "companyname": "",
            "services": 1
         },
         {
            "id": "2",
            "firstname": "Random",
            "lastname": "Customer",
            "datecreated": "2011-10-05",
            "email": "[email protected]",
            "companyname": "companyname",
            "services": 13
         },
         {
            "id": "1",
            "firstname": "John",
            "lastname": "Doe",
            "datecreated": "2011-09-24",
            "email": "[email protected]",
            "companyname": "",
            "services": 26
         }
      ],
      "call": "getClients",
      "server_time": 1323444040
   }