API:getDomains - Get domains

Get list of domains.

Optional parameters

page

Which page to return

list

Status of domains to list, possible values: all, active, expired, pending, pending_transfer, pending_registration

Request

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

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

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

Response

   {
      "success": true,
      "domains": [
         {
            "id": "13",
            "manual": "0",
            "name": "silo3.mobi",
            "lastname": "Doe",
            "firstname": "John",
            "cid": "1",
            "period": "1",
            "recurring_amount": "9.95",
            "currency_id": "0",
            "module": "namesilo",
            "next_due": "2012-12-12",
            "expires": "2012-12-12",
            "status": "Active",
            "type": "Register",
            "date_created": "2011-12-12",
            "autorenew": "1",
            "reglock": "1",
            "idprotection": "1"
         },
         {
            "id": "11",
            "manual": "0",
            "name": "netearthorg.org",
            "lastname": "Doe",
            "firstname": "John",
            "cid": "1",
            "period": "1",
            "recurring_amount": "9.95",
            "currency_id": "0",
            "module": "NetEarthOne",
            "next_due": "2012-11-22",
            "expires": "2012-11-22",
            "status": "Active",
            "type": "Register",
            "date_created": "2011-11-22",
            "autorenew": "1",
            "reglock": "1",
            "idprotection": "0"
         },
         {
            "id": "10",
            "manual": "0",
            "name": "hbappreseller.co.uk",
            "lastname": "Blue",
            "firstname": "Mike",
            "cid": "6",
            "period": "2",
            "recurring_amount": "9.95",
            "currency_id": "0",
            "module": "NetEarthOne",
            "next_due": "2012-11-22",
            "expires": "0000-00-00",
            "status": "Pending",
            "type": "Register",
            "date_created": "0000-00-00",
            "autorenew": "1",
            "reglock": "0",
            "idprotection": "0"
         }
      ],
      "call": "getDomains",
      "server_time": 1323793581
   }