Get All Subaccounts

Retrieve all subaccounts (team members) associated with the current customer account.

📥 Get All Subaccounts

This endpoint fetches a list of all active subaccounts (children) under the current logged-in customer.


🔹 HTTP Request

GET API-URL/children

🔐 Authorization Header

X-API-KEY: your-api-key-here

💻 PHP Example

// GET ALL SUBACCOUNTS
$response = $endpoint->getChildren();

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success",
  "data": {
    "count": 2,
    "records": [
      {
        "child_uid": "6827da91aa67",
        "first_name": "Alice",
        "last_name": "Brown",
        "email": "[email protected]",
        "status": "active",
        "timezone": "Asia/Kolkata",
        "date_added": "2025-05-10 13:22:10"
      },
      {
        "child_uid": "5c9adf212ff3",
        "first_name": "David",
        "last_name": "Morris",
        "email": "[email protected]",
        "status": "inactive",
        "timezone": "Europe/London",
        "date_added": "2025-03-21 10:08:47"
      }
    ]
  }
}

🧾 Notes

  • Only subaccounts under the authenticated customer account will be listed.

  • Pagination parameters (if supported) can be added for extended results.

Last updated