latestOpenAPI 3.0.12026-08-108798310.5 KB

fa1a72b9ecec

Accounts

Get the accounts associated with an account holder

This endpoint returns a list of the accounts that you can access using the access token you supplied in the request header.

Each access token is associated with a single account holder, who may have more than one account (for example, a GBP account and a euro account). This endpoint returns all the accounts that the account holder has given you permission to access.

Note that an account holder in this context is either a personal account holder, or a sole trader account holder, or a business account holder or a joint account holder. An individual person may be more than one of these kinds of account holder, but each kind of account holder is a separate entity and hence requires a separate access token and permission.

Categories are subdivisions of an account. The default category holds the main balance and transactions. Savings goals and spending spaces are examples of other categories. You can use /api/v2/accounts to get the default category UID for an account.

get/api/v2/accounts

Response

Successful operation

Example response

{
  "accounts": [
    {
      "accountUid": "bbccbbcc-bbcc-bbcc-bbcc-bbccbbccbbcc",
      "accountType": "PRIMARY",
      "defaultCategory": "ccddccdd-ccdd-ccdd-ccdd-ccddccddccdd",
      "currency": "GBP",
      "name": "Personal"
    }
  ]
}