Skip to main content
GET
/
v1
/
sub-organizations
List sub-accounts
curl --request GET \
  --url https://api.wavix.com/v1/sub-organizations \
  --header 'Authorization: Bearer <token>'
{
  "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": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

status
enum<string>

Account status to filter results.

Available options:
enabled,
disabled
Example:

"enabled"

Response

List of sub-accounts.

sub_organizations
SubOrganizationResponse · object[]
pagination
Pagination · object