Skip to main content
GET
/
users
/
{id}
/
accounts
/users/{id}/accounts
curl --request GET \
  --url http://localhost:8080/users/{id}/accounts \
  --header 'Authorization: Bearer <token>'
{
  "links": {}
}
curl -i -X GET \
  'http://localhost:8080/users/{id}/accounts?account_id=string&institution_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'moneykit-version: 2023-02-18'

{
  "links": {
    "link_id1": {
      "accounts": [
        {
          "account_id": "a3ba443a-257c-490e-8242-03a84789d39f",
          "account_type": "checking",
          "name": "Premier Checking",
          "account_mask": "3748",
          "balances": {
            "currency": "USD",
            "available": 340.12,
            "current": 445.89,
            "limit": 500
          }
        }
      ],
      "last_synced_at": "2023-02-16T09:14:11"
    },
    "link_id2": {
      "accounts": [
        {
          "account_id": "a3ba443a-257c-490e-8242-03a84789d39f",
          "account_type": "checking",
          "name": "Premier Checking",
          "account_mask": "3748",
          "balances": {
            "currency": "USD",
            "available": 340.12,
            "current": 445.89,
            "limit": 500
          }
        }
      ],
      "last_synced_at": "2023-02-16T09:14:11"
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
moneykit-version
string
default:2023-02-18

Path Parameters

​
id
string
required

The unique ID for this user. This is the same ID provided in the call to /link-session to create any link for this user.

Query Parameters

​
account_id
string[]

If present, filters results to accounts matching the given IDs.

​
institution_id
string[]

If present, filters results to accounts at institutions matching the given IDs.

Response

Successful Response

​
links
object
required

The set of all accounts belonging to this user, as a dictionary of {link_id:[accounts]}.