SiteHost API: /accounts/client/list_sub

/accounts /client /list_sub_accounts

GET https://api.sitehost.nz/1.2/accounts/client/list_sub_accounts.json

List all sub-accounts for a client.

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client.Example: 1
filters[name]	string		Only show sub-accounts that (partially) match the given name.Example: John
filters[include_closed]	boolean		Include sub-accounts which have been closed.Example: 1
filters[sort_by]	string		The field name to sort the results by.
filters[sort_dir]	string		The direction to sort in. Valid options are ASC and DESC
filters[page_size]	integer		The number of items to return per page.
filters[page_number]	integer		The page number to return.

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.2/accounts/client/list_sub_accounts.json?apikey=your_key_here&client_id=1&filters[name]=John&filters[include_closed]=1", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/accounts/client/list_sub_accounts.json?apikey=your_key_here&client_id=1&filters[name]=John&filters[include_closed]=1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

require 'net/http'
require 'uri'

uri = URI.parse("https://api.sitehost.nz/1.2/accounts/client/list_sub_accounts.json?apikey=your_key_here&client_id=1&filters[name]=John&filters[include_closed]=1")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri)

response = http.request(request)

import requests

uri = 'https://api.sitehost.nz/1.2/accounts/client/list_sub_accounts.json?apikey=your_key_here&client_id=1&filters[name]=John&filters[include_closed]=1'

response = requests.get(uri)

Response

200:

application/json

{
  "return": {
    "total_items": 2,
    "current_items": 2,
    "current_page": 1,
    "total_pages": 1,
    "data": [
      {
        "client_id": "960001",
        "name": "John Smith",
        "account_balance": "100.12",
        "joined": "2022-07-20",
        "closed": "0000-00-00",
        "account_type": "TOPUP"
      },
      {
        "client_id": "960002",
        "name": "Gordon Freeman",
        "account_balance": "41.2",
        "joined": "2004-11-16",
        "closed": "0000-00-00",
        "account_type": "CREDIT"
      }
    ]
  }
}