Skip to main content
GET
List Sub-Accounts

Authorizations

X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Query Parameters

limit
integer
default:20

Number of records to return per request. Default 20.

Example:

10

offset
integer
default:0

Number of initial records to skip for pagination.

Example:

0

Case-insensitive search against sub-account names.

Example:

"Production"

Response

List of sub-accounts.

id
integer<int64>

Unique identifier for the sub-account

Example:

50441

accountId
integer<int64>

Identifier of the parent account this sub-account belongs to

Example:

4021

name
string

Display name for the sub-account. Must be unique within your account. Use descriptive names.

Maximum string length: 100
Example:

"Transactional - Production"

apiKey
string

API key for this sub-account. Use this as the X-SubAccount-ApiKey header when making API calls for this sub-account (sending emails, managing domains, etc.).

Security: Treat this like a password. Rotate if compromised.

Example:

"pR0YIuxYSbVwmQi2Y8Qs"

type
enum<integer>

Type of sub-account:

  • 0 = Default (the primary sub-account created with your account)
  • 1 = Custom (additional sub-accounts you create)

Note: The default sub-account cannot be deleted.

Available options:
0,
1
Example:

1

isPlus
boolean

Whether this sub-account belongs to a SendX Plus customer. SendX Plus is a premium tier that provides enhanced features and support.

Example:

false

labels
object[]

Custom labels for organizing and filtering sub-accounts

blocked
boolean

Whether the sub-account is blocked from sending. A blocked sub-account cannot send emails. Common reasons:

  • High bounce/spam rates
  • Billing issues
  • Policy violations
  • Manual suspension by administrator
Example:

false

created
integer<int64>

UNIX epoch timestamp in nanoseconds when the sub-account was created

Example:

1704067200000000000