Skip to main content
GET
List subaccounts

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Path Parameters

customerId
string
required

Unique Identifier for the customer

Query Parameters

endDate
string<date>

The end date (inclusive) in YYYY-MM-DD format. The latest valid end date is the current date. Dates are always in UTC RFC 3339 'full-date'.

afterId
string

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

statuses
string[]

Filter subaccounts by status

limit
integer<int64>
default:25

Maximum number of results to return per query

Required range: 1 <= x <= 100

Response

Successfully returned subaccounts

data
SubaccountsDetails · object[]
required
page
Page · object

Pagination info