Skip to main content
GET
List sub-accounts

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>

Filters sub-accounts by status. One of enabled (the sub-account is active) or disabled (the sub-account is suspended).

Available options:
enabled,
disabled
Example:

"enabled"

Response

Returns a paginated list of sub-accounts.

sub_organizations
SubOrganizationResponse · object[]

Subaccounts belonging to the authenticated account.

pagination
Pagination · object