Get a subaccount

View as Markdown

Get one subaccount. Pass include=usage to inline current usage and quota state.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

subaccountIdstringRequired1-64 characters
Opaque identifier for a BCTRL subaccount.

Query parameters

includelist of enumsOptional
Include optional subaccount expansions. Repeat the query parameter for multiple values.
Allowed values:

Response

OK
createdAtstring
defaultSpaceIdstringformat: "uuid"
idstring1-64 characters
Opaque identifier for a BCTRL subaccount.
limitsobject
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

statusenum
updatedAtstring
archivedAtstring or nullOptional
externalIdstring or nullOptional
metadataobject or nullOptional
usageobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error