List subaccounts

View as Markdown

List subaccounts using the simplified response envelope. Pass include=usage to inline current usage.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Query parameters

cursorstringOptional
limitintegerOptional<=200Defaults to 50
includelist of enumsOptional
Include optional subaccount expansions. Repeat the query parameter for multiple values.
Allowed values:
statusenumOptional
Filter subaccounts by lifecycle status.
Allowed values:
externalIdstringOptional1-200 characters
qstringOptional1-200 characters

Response

OK
datalist of objects
nextCursorstring or null

Errors

401
Unauthorized Error
403
Forbidden Error