Accounts

Get accounts

Returns a paginated list of accounts.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching accounts. Both user and business accounts are returned.

See the Accounts overview (TOL / BYOL / Omnibus) for account types and the account hierarchy.

get/accounts

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/accounts
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: accounts:read, accounts:admin)

Query parameters

sort'created_at' | 'updated_at'

The field to sort the results by. One of created_at or updated_at; defaults to created_at.

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

OK

Changes

No recorded changes to this operation across all 25 revisions of this API.