WHMCS · Example Payload

Whmcs Get Clients Example

Retrieve a paginated list of client accounts from WHMCS.

Web HostingBilling AutomationClient ManagementDomain ManagementSupport TicketsProvisioning

Whmcs Get Clients Example is an example object payload from WHMCS, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationdescriptionrequestresponse

Example Payload

{
  "operation": "GetClients",
  "description": "Retrieve a paginated list of client accounts from WHMCS.",
  "request": {
    "method": "POST",
    "url": "https://example.com/includes/api.php",
    "headers": {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    "body": {
      "identifier": "your-api-identifier",
      "secret": "your-api-secret",
      "action": "GetClients",
      "responsetype": "json",
      "limitstart": 0,
      "limitnum": 25,
      "sorting": "ASC"
    }
  },
  "response": {
    "status": 200,
    "body": {
      "result": "success",
      "totalresults": 2,
      "startnumber": 0,
      "numreturned": 2,
      "clients": {
        "client": [
          {
            "id": 1,
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "datecreated": "2024-01-15",
            "groupid": 0,
            "status": "Active",
            "credit": 0.00,
            "country": "US"
          },
          {
            "id": 2,
            "firstname": "Jane",
            "lastname": "Smith",
            "email": "jane.smith@example.com",
            "datecreated": "2024-03-22",
            "groupid": 0,
            "status": "Active",
            "credit": 25.00,
            "country": "GB"
          }
        ]
      }
    }
  }
}