Sub-accounts
List sub-accounts
Returns a paginated list of sub-accounts under the authenticated master account.
get/v1/sub-organizations
Query parameters
status'enabled' | 'disabled'
Example:enabled
Filters sub-accounts by status. One of enabled (the sub-account is active) or disabled (the sub-account is suspended).
Response
Returns a paginated list of sub-accounts.
Example response
{
"sub_organizations": [
{
"id": 123,
"created_at": "2023-06-15T10:30:00Z",
"name": "My sub-account",
"api_key": "abc123def456",
"master_organization": 456,
"status": "enabled",
"default_destinations": {
"sms_endpoint": "https://examples.com/sms",
"dlr_endpoint": "https://examples.com/dlr"
}
}
],
"pagination": {
"current_page": 2,
"per_page": 25,
"total": 101,
"total_pages": 5
}
}