GET
/
institutions
/institutions
curl --request GET \
  --url http://localhost:8080/institutions \
  --header 'Authorization: Bearer <token>'
{
  "institutions": [
    {
      "institution_id": "chase",
      "institution_id_aliases": [
        "bf6856b2-0460-4e1e-b837-8dd9c1338bc1",
        "ins_56"
      ],
      "name": "Chase",
      "country": "US",
      "domain": "chase.com",
      "color": "#0A89FF",
      "color_dark": "#0A89FF",
      "is_featured": true
    }
  ],
  "cursors": {
    "next": "c2FtcGxlIGN1cnNvcg=="
  }
}
curl -i -X GET \
  'http://localhost:8080/institutions?name=string&featured=false&cursor=string&limit=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'moneykit-version: 2023-02-18'

{
  "institutions": [
    {
      "institution_id": "chase",
      "institution_id_aliases": [
        "bf6856b2-0460-4e1e-b837-8dd9c1338bc1",
        "ins_56"
      ],
      "name": "Chase",
      "country": "US",
      "domain": "chase.com",
      "color": "#0A89FF",
      "color_dark": "#0A89FF",
      "is_featured": true
    }
  ],
  "cursors": {
    "next": "c2FtcGxlIGN1cnNvcg=="
  }
}

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

Query Parameters

​
name
string

If provided, returns only institutions containing this name (wholly or as a prefix).

​
featured
boolean
default:false

If true, returns only featured institutions.

​
cursor
string

Cursor to fetch the next set of institutions. (You get this value from the previous call to /institutions)

​
limit
integer
default:50

A limit on the number of institutions to be returned.

Required range: 1 <= x <= 100

Response

200
application/json

Successful Response

The response is of type object.