Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Links

List links

▶️ Usage

With the List Links method, you can:

  1. List all links elated to your Belvo account (without using any query parameters).
  2. Get the details of a specific link.id (using the id query parameter).

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

get/api/links/

Query parameters

page_sizeinteger
Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

pageinteger
Example:1

A page number within the paginated result set.

omitstring

Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

fieldsstring

Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.

idstring uuid
Example:24ccab1d-3a86-4136-a6eb-e04bf52b356f

Return information only for this resource id.

id__instring[]

Return information for these resource ids.

[
  "6b3dea0f-be29-49d1-aabe-1a6d588642e6"
]
institutionstring
Example:planet_mx_retail

Return results only for this institution (use the Belvo-designated name, such as planet_mx_employment).

institution__instring[]

Return results only for these institutions (use the Belvo-designated names, such as ofmockbank_br_retail and planet_mx_employment).

[
  "planet_mx_retail"
]
access_mode'single' | 'recurrent'
Example:single

Return links only with this access mode. Can be either single or recurrent.

created_atstring date
Example:2022-05-05

Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).

created_at__gtstring date
Example:2022-05-05

Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).

created_at__gtestring date
Example:2022-05-04

Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).

created_at__ltstring date
Example:2022-04-01

Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).

created_at__ltestring date
Example:2022-03-30

Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).

created_at__rangestring[]

Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.

[
  "2022-01-01",
  "2022-12-31"
]
created_by__not_instring[]

Return links that were not created by these Belvo users.

[
  "d9475f4d-c511-4732-9ef0-93b5672f43d3"
]
external_idstring
Example:InternalUser4000

Return links with this external ID.

external_id__instring[]

Return links with these external IDs.

[
  "InternalUser4001"
]
institution_user_idstring
Example:ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=

Return links with this specific institution user ID.

institution_user_id__instring[]

Return links with these institution user IDs.

[
  "ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0="
]
refresh_ratestring
Example:24h

Return links with this refresh rate. Choose between 6h, 12h, 24h, 7d, 30d, or null (for single links).

statusstring
Example:invalid

Return links with this status. Choose between valid, invalid, unconfirmed, or token_required.

status__instring[]

Return links with these statuses. Choose between valid, invalid, unconfirmed, or token_required.

[
  "invalid"
]

Response

Ok

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
      "institution": "erebor_mx_retail",
      "access_mode": "recurrent",
      "last_accessed_at": "2021-03-09T10:28:40.000Z",
      "created_at": "2022-02-09T08:45:50.406032Z",
      "external_id": "56ab5706-6e00-48a4-91c9-ca55968678d9",
      "institution_user_id": "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c=",
      "status": "valid",
      "created_by": "bcef7f35-67f2-4b19-b009-cb38795faf09",
      "refresh_rate": "7d",
      "credentials_storage": "27d",
      "fetch_resources": [
        "ACCOUNTS",
        "TRANSACTIONS"
      ],
      "stale_in": "42d"
    }
  ]
}