Skip to main content
GET
Retrieve a sub-account

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.

Path Parameters

id
integer<int32>
required

The unique ID of the sub-account.

Example:

123

Response

Returns the sub-account.

Sub-account details including API key and webhook configurations.

id
integer<int32>
required

Sub-account ID.

Example:

123

created_at
string<date-time>
required

Date and time the sub-account was created in ISO 8601 format.

Example:

"2023-06-15T10:30:00Z"

name
string
required

Sub-account name.

Example:

"My sub-account"

api_key
string
required

Sub-account API key.

Example:

"abc123def456"

master_organization
integer<int32>
required

Master account ID.

Example:

456

status
enum<string>
required

Status of the subaccount. One of enabled (the subaccount is active and can be used) or disabled (the subaccount is suspended).

Available options:
enabled,
disabled
Example:

"enabled"

default_destinations
object
required

Default webhook URLs for inbound messages and delivery reports.