List pool accounts
GET
/pool-accountsReturns a paginated list of pool accounts for the company in the companyId header. Supports filtering by status, creator, manager, and creation time range.
Query parameters
pagenumberExample
1pageSizenumberExample
20statusstringallactiveinactiveterminatedcreatedTimeTostringcreatedTimeFromstringcreatedBystringmanagerIdstring
Header parameters
companyIdstringrequiredID of the company to filter records
x-api-keystringrequiredPlease provide a valid API Key
Response
| Field | Type | Description |
|---|---|---|
page | number | |
totalPages | number | |
total | number | |
data | object[] | |
id | string | |
accountName | string | |
status | string | |
currency | string | |
topupType | string | |
allowedMaxBalance | number | |
lowBalanceNotificationActive | boolean | |
lowBalanceNotificationAmount | number | |
companyName | string | |
createdAt | string | |
createdBy | object | |
accountManagers | object[] |
5 nested fields
data[].createdBy.userId | string | |
data[].createdBy.name | string | |
data[].accountManagers[].userId | string | |
data[].accountManagers[].name | string | |
data[].accountManagers[].email | string |
Errors
400Bad Request
Every error carries an errors[] array and a meta.request_id. See Errors for the full envelope.