Get Accounts
List accounts the authenticated user has permission to access.
Results can be narrowed with the optional account_id and account_name filters. account_id is a lexicographic prefix match on the decimal account id (e.g. 100 matches 100345 and 100567); account_name is a case-insensitive substring match on the account's full name. When both are supplied an account must match both. When neither is supplied every accessible account is returned.
Query parameters
The number of items to return per page. Only used when page_token is not provided.
Base64URL-encoded pagination token
Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.
Filter to accounts whose id starts with this value (lexicographic prefix match on the decimal id, e.g. 100 matches 100345).
Filter to accounts whose full name contains this value (case-insensitive substring match).
Response
List of accounts
Example response
{
"error": {
"code": 400,
"message": "Order quantity must be greater than zero"
},
"data": [
{
"account_holder_entity_id": 987654321,
"close_date": null,
"full_name": "Test Trading Account",
"id": 19816,
"open_date": "2023-01-15",
"options_level": 1,
"short_name": "TST-ACCOUNT-01",
"status": "ACTIVE",
"subtype": "MARGIN",
"type": "CUSTOMER"
}
]
}