Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Accounts

List Accounts

List a list of user accounts.

get/accounts

Query parameters

sizeinteger
Example:50

The number of objects you want returned in a collection.

cursorstring

Uses the filter values of the previous page to determine the next set of items.

userIdstring

Filter to those associated with a particular user ID.

startDatestring date
Example:2021-04-01

Filter by account linking date, start of date range (YYYY-MM-DD)

endDatestring date
Example:2021-04-21

Filter by account linking date, end of date range (YYYY-MM-DD)

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "nextCursor": "1259723474",
    "items": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "createdAt": "2021-04-14T09:30:24Z",
        "providerId": "grab",
        "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8",
        "connectionStatus": "CONNECTED",
        "monitorStatus": "ACTIVE",
        "monitor": {
          "status": "ACTIVE",
          "updatedAt": "2021-04-14T09:30:24Z"
        },
        "connection": {
          "status": "CONNECTED",
          "errorCode": "ACCOUNT_DISABLED",
          "errorMessage": "Account is disabled",
          "updatedAt": "2021-04-14T09:30:24Z"
        }
      }
    ]
  }
}