---
title: "List links"
method: GET
path: "/links"
tags: ["Links"]
---

# List links

`GET /links`

Returns a paginated list of the links of your organization, in the `live` or `test` mode of the API key used. `link_token` and `accounts` are always `null` when listing links.

## Query parameters

- `status` 'active' | 'inactive' | 'login_required'
- `page` integer
- `per_page` string

## Response `200`

Paginated list of links. The `Link` and `X-Total-Count` headers carry the pagination information.

- Link[]
  - `id` string, required — Unique identifier of the link.
  - `object` 'link', required — Type of the object. Always `link`.
  - `accounts` Account[], nullable, required — Bank accounts of the link. Included when retrieving or exchanging a single link; `null` when listing or updating links.
    - `id` string, required — Unique identifier of the account.
    - `object` 'account', required — Type of the object. Always `account`.
    - `available_balance` integer, required — Available balance of the account, in the smallest currency unit. For MXN the smallest unit is the centavo; for CLP it is the peso, which has no minor unit.
    - `currency` 'CLP' | 'MXN', required — ISO 4217 currency code of the account. One of `CLP`, `MXN`.
    - `description` string, nullable, required — Free-text description of the account, or `null` when none is set.
    - `entity` object, required — Owner entity of the account.
      - `id` string, required — Identifier of the entity.
      - `holder_id` string, required — Tax identifier of the owner. A Chilean tax ID (RUT) or a Mexican tax ID (RFC).
      - `holder_name` string, required — Legal name of the owner.
      - `is_root` boolean, required — Whether this entity is the root entity.
    - `is_root` boolean, required — Whether this account is the organization's root account.
    - `mode` 'live' | 'test', required — Whether the account holds `live` or `test` data.
    - `root_account_number` string, required — Default account number of the account. In Mexico, the 18-digit standardized bank account number (CLABE); in Chile, the bank account number.
    - `root_account_number_id` string, required — Identifier of the default account number.
    - `status` 'active' | 'blocked' | 'closed', required — Status of the account. One of `active`, `blocked`, `closed`.
  - `active` boolean, required — Whether the link is active. Fintoc does not refresh inactive links. Deactivating a link stops refreshes but does not revoke the `link_token`'s access to already-collected data.
  - `created_at` string, date-time, required — ISO 8601 timestamp of when the link was created.
  - `holder_id` string, required — Tax identifier of the account holder, without dots or hyphens (RUT in Chile, RFC in Mexico).
  - `holder_type` 'individual' | 'business', required — Whether the account holder is an individual or a business.
  - `institution` Institution, required
    - `id` string, required — Unique identifier of the institution.
    - `country` string, required — ISO 3166-1 alpha-2 code of the country of the institution.
    - `name` string, required — Name of the institution.
  - `last_time_refreshed` string, date-time, nullable, required — ISO 8601 timestamp of the link's last refresh. `null` if Fintoc has never refreshed the link.
  - `link_token` string, nullable, required — Token used to authenticate requests for the link's resources. Only returned when the link is exchanged; `null` in every other response.
  - `mode` 'test' | 'live', required — Mode of the object. `live` objects use real institution data, `test` objects use fake data for integration testing.
  - `refresh_status` 'idle' | 'refreshing' | 'interrupted' | 'partially_refreshing' | 'null', nullable, required — Refresh status of the link's accounts. `idle` means no refresh is in progress, `refreshing` means every account is refreshing, `partially_refreshing` means only some accounts are refreshing, and `interrupted` means no account is currently refreshing.
  - `status` 'active' | 'inactive' | 'login_required', required — Status of the link. `login_required` means the institution rejected the stored credentials and you must reconnect the link.
  - `subscription_id` string — Identifier of the subscription associated to the link. Only present when the link is returned from a subscription exchange.
  - `username` string, required — Username used to log in at the institution, without dots or hyphens.

## Other responses

- `400` — Invalid request: the `status` is not one of the valid values.
- `401` — Invalid or missing API key.

---

[API](https://skmtc.net/fintoc/apis/fintoc-api.md) · [All operations](https://skmtc.net/fintoc/apis/fintoc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fintoc/fintoc-api/versions/9dafa63688a3/schema)