Listing Accounts

Listing/scrolling through accounts can be done via the following endpoint.

GET https://driftapi.com/accounts

Accepted Query Parameters

'index': Used as a starting index of the the accounts query in the authenticated Drift user's account.
'size': Number of accounts per batch (default=10, max=65)

The response returned will have the structure below:

{
  "data": {
    "accounts": [ // List of account objects
      (Account Model),
      ...
     ],
     "total": XXX (int), // Total number of accounts
     "next": "/accounts?index=XXX&size=XXX" // the next query url to continue scrolling
  }
}

❗️

Note that the 'next' field may not always be present

Note that once the accounts are exhausted, the 'next' field will be absent from the response body.

Listing accounts requires the account_read scope.


Did this page help you?