Get all Accounts in a paginated listing.

Query Parameters

page integer
Possible values: >= 1
Default value: 1
The page number in a paginated listing.
items integer
Possible values: >= 1 and <= 20
Default value: 20
The number of items to return on each page.
externalId string
Filter records by externalId
userId uuid
Filter records by userId

Responses

All the accounts in a paginated listing.

application/json

Schema
Example (from schema)

Schema

accounts object[]
Array [
oneOf
account.SharedSavings
account.Performance
type string required
Possible values: [SharedSavings]
id uuid required
externalId string
Optional, external reference for this account.
user object required
type string required
id string required
externalId string
balanceCents account.BalanceCents
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
type string required
Possible values: [Performance]
id uuid required
externalId string
Optional, external reference for this account.
user object required
type string required
id string required
externalId string
balanceCents account.BalanceCents
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
liquidBalanceCents account.LiquidBalanceCents
Default value: 0
The amount of liquid cash available for withdrawal or internal transfer, in cents or the smallest currency subunit.
performanceCents account.PerformanceCents
Default value: 0
The value gained since valuationFrom, in cents or the smallest currency subunit.
performancePercent account.PerformancePercent
Default value: 0
The relative value gained since valuationFrom, in percent.
totalAcquisitionCostCents account.TotalAcquisitionCostCents
Default value: 0
The total acquisition cost of the assets on the account, in cents or the smallest currency subunit.
valuationFrom object
The date time performance indicators are calculated from.
valuationAt object
Default value: Time of last update
The date time of market valuation for the assets on the account.
]

meta object

next_url url

URL for the next page.

count integer

The total count of items.

items integer

The number of returned items on this page.

pages integer

The number of pages.

from integer

Index of the first item on this page (starting from 1).

to integer

Index of the last item on this page.

{
  "accounts": [
    {
      "type": "SharedSavings",
      "id": "7edd1904-2e55-463a-a359-458d7832af7e",
      "externalId": "GB77BARC20201530093459",
      "user": {
        "type": "user",
        "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
        "externalId": "10002345"
      },
      "balanceCents": 123456
    },
    {
      "type": "Performance",
      "id": "9b2d409f-c441-42d8-887d-6b84499fc34e",
      "externalId": "GB77BARC20201530093459",
      "user": {
        "type": "user",
        "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
        "externalId": "10002345"
      },
      "balanceCents": 123500,
      "liquidBalanceCents": 500,
      "performanceCents": 23000,
      "performancePercent": 23,
      "totalAcquisitionCostCents": 100000,
      "valuationFrom": "2022-01-01T13:45:12Z",
      "valuationAt": "2023-02-23T09:00:00Z"
    }
  ],
  "meta": true
}

Get all Accounts in a paginated listing.​

Get all Accounts in a paginated listing.