Get all Accounts in a paginated listing.
GEThttps://your-api.impactfinance.domain/v1/accounts
Get all Accounts in a paginated listing.
Request
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
- 200
All the accounts in a paginated listing.
- application/json
- Schema
- Example (from schema)
Schema
accounts
object[]
meta
object
{
"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
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL