List sub-accounts

GET

/v1/account/subaccounts

Requires SUB_ACCOUNTS_READ, granted by TREASURY_READ or TREASURY_WRITE (bundles)

Lists your primary account (id 0, label Primary) followed by its sub-accounts, newest first. Deleted sub-accounts, and your payments payout, collections and funding accounts, aren't listed. Call it on your primary account (don't send X-VALR-SUB-ACCOUNT-ID); keys limited to some sub-accounts can't use it.

Parameters

Query Parameters

includeTags

true to include each account's accountTags.

Type

boolean

Exampletrue

Default

false

includePayoutAccounts

true to include autoPayoutLinkedBankAccountId for accounts that pay out to a bank account automatically.

Type

boolean

Examplefalse

Default

false

Responses

OK

Content-Type

application/json

[

{

"label": "Primary",

"id": "0"

},

{

"label": "Treasury",

"id": "7340032581337088"

},

{

"label": "Client Funds",

"id": "7339876125413376"

}

]

Samples

Errors

HTTP	Error	When
400	-11INVALID_REQUEST	includeTags or includePayoutAccounts isn't true or false.

Plus the errors common to all signed endpoints.