Get all Accounts in a paginated listing.
GET/accounts
Get all Accounts in a paginated listing.
Request
Query Parameters
Possible values: >= 1
Default value: 1
The page number in a paginated listing.
Possible values: >= 1 and <= 20
Default value: 20
The number of items to return on each page.
Filter records by externalId
Filter records by userId
Responses
- 200
All the accounts in a paginated listing.
- application/json
- Schema
- Example (from schema)
Schema
Array [
- account.SharedSavings
- account.Performance
]
accounts
object[]
oneOf
Possible values: [SharedSavings]
Optional, external reference for this account.
user
object
required
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
Possible values: [Performance]
Optional, external reference for this account.
user
object
required
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
Default value: 0
The amount of liquid cash available for withdrawal or internal transfer, in cents or the smallest currency subunit.
Default value: 0
The value gained since valuationFrom, in cents or the smallest currency subunit.
Default value: 0
The relative value gained since valuationFrom, in percent.
Default value: 0
The total acquisition cost of the assets on the account, in cents or the smallest currency subunit.
The date time performance indicators are calculated from.
Default value: Time of last update
The date time of market valuation for the assets on the account.
meta
object
URL for the next page.
The total count of items.
The number of returned items on this page.
The number of pages.
Index of the first item on this page (starting from 1).
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
}