Retrieve Sub-accounts

curl --request GET \
  --url https://api.mailchannels.net/tx/v1/sub-account \
  --header 'X-Api-Key: <x-api-key>'

[
  {
    "enabled": true,
    "handle": "<string>",
    "company_name": "<string>"
  }
]

GET

sub-account

curl --request GET \
  --url https://api.mailchannels.net/tx/v1/sub-account \
  --header 'X-Api-Key: <x-api-key>'

[
  {
    "enabled": true,
    "handle": "<string>",
    "company_name": "<string>"
  }
]

X-Api-Key

string

required

limit

integer

default:1000

The maximum number of sub-accounts to return. The default is 1000.

Required range: 1 <= x <= 1000

offset

integer

default:0

The number of sub-accounts to skip before returning results. The default is 0.

Required range: x >= 0

Successfully retrieved all sub-accounts associated with the parent account.

Maximum array length: 1000

enabled

boolean

required

handle

string

required

company_name

string

⌘I