List subaccounts
Retrieve a paginated list of all subaccounts for your root entity, with current balances and virtual banking details.
Query Parameters
Response Body
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
cursor
Cursor for pagination. Use the next_cursor from the previous response to get the next page.
limit
Number of items to return per page. Minimum is 10. Maximum is 500.
order
Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)
Allowed values:
name
Filter subaccounts by name (case-insensitive partial match)
Response
List of subaccounts retrieved successfully