DocsAPI Reference
Log In
API Reference

Search institution connections

Retrieve institution connections filtered by various parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Meld generated unique identifier for your customer. This should be used to track customer activity.

string

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.

string

Institution id. If present, only institution connections with this institution will be included.

string

Comma separated list of institution connection statuses. If present, only institution connections with these statuses will be included.

Find out more about connection statuses <a href=https://docs.meld.io/docs/connection-statuses-and-errors>here.

string

Comma separated list of service providers. If present, only institution connections with these service providers will be included.

Note: Reference <a href=https://docs.meld.io/docs/creating-connections#supported-service-providers>Supported Service Providers for the list of available bank linking providers.

date

Start date to begin search from of format yyyy-mm-dd

date

End date stop search on of format yyyy-mm-dd

string

Unique key corresponding to an institution connection's position in the paginated list of results -- used to indicate that only institution connections residing before this key will be retrieved.

Each institution connection carries a unique key. Reference <a href=https://docs.meld.io/docs/pagination>Pagination

The before and after fields cannot be used in the same request.

string

Unique key corresponding to a institution connection's position in the paginated list of results -- used to indicate that only institution connections residing after this key will be retrieved.

Each institution connection carries a unique key. Reference <a href=https://docs.meld.io/docs/pagination>Pagination

The before and after fields cannot be used in the same request.

int32

Limits number of returned institution connections.

Default value: 10

Minimum value: 1

Maximum value: 100

string

Institution name. If present, only institution connections with this institution will be included.If institutionId is present then institutionId will take precedence.

Responses

400

Bad Request : check request values and format

401

Invalid credentials

403

Unauthenticated or authenticated with insufficient access

500

Server Error. This applies to all 5xx errors, including but not limited to 500, 501, 502, 503, and 504 errors. You should treat all of these errors the same.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*