API ReferenceSubaccounts API

List subaccounts

View as Markdown
Retrieve a paginated list of all subaccounts for your root entity, with current balances and virtual banking details. **Query Parameters** | Field | Type | Required | Description | |-------|------|----------|-------------| | `cursor` | String | No | Cursor for pagination. Use the `next_cursor` from the previous response to get the next page | | `limit` | Integer | No | Number of items to return per page. Maximum is 100 (default: 50) | | `order` | String | No | Sort order by created_at: 'asc' for oldest first, 'desc' for newest first (default: 'desc') | | `name` | String | No | Filter subaccounts by name (case-insensitive partial match) | **Response Body** | Field | Type | Description | |-------|------|-------------| | `data` | Array | Array of subaccount objects | | `has_more` | Boolean | Whether there are more results available | | `total_count` | Integer | Total number of subaccounts | | `next_cursor` | String | Cursor for the next page (null if no more results) | | `previous_cursor` | String | Cursor for the previous page | **Pagination** This endpoint supports cursor-based pagination. Results are ordered by creation date (newest first by default).

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitinteger or nullOptional10-500Defaults to 50
Number of items to return per page. Maximum is 500.
orderenum or nullOptionalDefaults to desc

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:
namestring or nullOptional

Filter subaccounts by name (case-insensitive partial match)

Response

List of subaccounts retrieved successfully