# Enumerar enlaces

## ▶️ Uso

Con el método List Links, puedes:

1. Listar todos los enlaces relacionados con tu cuenta de Belvo (sin usar parámetros de consulta).
2. Obtener los detalles de un  específico (usando el parámetro de consulta ).

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta  para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta  para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación.

## 🔦 Filtrado de Respuestas

Consulta la lista de campos a continuación para ver los campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

Endpoint: GET /api/links/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `omit` (string)
    Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `fields` (string)
    Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas.

  - `id` (string)
    Devuelve información solo para este recurso .
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Devuelve información para estos s de recursos.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `institution` (string)
    Devuelve resultados solo para esta institución (usa el nombre designado por Belvo, como ).
    Example: "planet_mx_retail"

  - `institution__in` (array)
    Devuelve resultados solo para estas instituciones (utiliza los nombres designados por Belvo, como  y ).
    Example: ["planet_mx_retail"]

  - `access_mode` (string)
    Devuelve enlaces solo con este modo de acceso. Puede ser  o .
    Enum: "single", "recurrent"

  - `created_at` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato ).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato ).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato ).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato ).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato ).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato ).
    Example: ["2022-03-03"]

  - `created_by__not_in` (array)
    Devolver enlaces que no fueron creados por estos usuarios de Belvo.
    Example: ["d9475f4d-c511-4732-9ef0-93b5672f43d3"]

  - `external_id` (string)
    Devuelve enlaces con este ID externo.
    Example: "InternalUser4000"

  - `external_id__in` (array)
    Devuelve enlaces con estos IDs externos.
    Example: ["InternalUser4001"]

  - `institution_user_id` (string)
    Devuelve enlaces con este ID de usuario de institución específico.
    Example: "ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0="

  - `institution_user_id__in` (array)
    Devuelve enlaces con estos IDs de usuario de la institución.
    Example: ["ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0="]

  - `refresh_rate` (string)
    Devuelve enlaces con esta frecuencia de actualización. Elige entre , , , ,  o  (para enlaces únicos).
    Example: "24h"

  - `status` (string)
    Devolver enlaces con este estado. Elija entre , ,  o .
    Example: "invalid"

  - `status__in` (array)
    Devuelve enlaces con estos estados. Elige entre , ,  o .
    Example: ["invalid"]

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es .

En nuestro ejemplo de documentación, usamos  como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo,  o ).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es .

  - `results` (array)
    Matriz de objetos de enlace.

  - `results.id` (string)
    Identificador único de Belvo para el elemento actual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.institution` (string)
    Nombre de la institución de Belvo.
    Example: "erebor_mx_retail"

  - `results.access_mode` (string,null)
    El tipo de enlace.
Para más información, consulta nuestro artículo de Enlaces.
Devolvemos uno de los siguientes valores de enum:
  - 
  - 
  -
    Enum: "single", "recurrent", null

  - `results.last_accessed_at` (string,null)
    La marca de tiempo ISO-8601 del acceso más reciente y exitoso de Belvo a la institución para el enlace dado.
    Example: "2021-03-09T10:28:40.000Z"

  - `results.created_at` (string)
    La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.external_id` (string)
    Un identificador adicional para el enlace, proporcionado por usted, para almacenar en la base de datos de Belvo.  incluir ninguna Información Personal Identificable (PII).  tener al menos tres caracteres de longitud.

Si identificamos que el identificador contiene PII, forzaremos un valor . Para más información, consulte nuestro artículo sobre la creación de enlaces.
    Example: "56ab5706-6e00-48a4-91c9-ca55968678d9"

  - `results.institution_user_id` (string)
    > 📘 Información
>
> Solo aplicable para enlaces creados .

Una cadena única de 44 caracteres que se puede usar para identificar a un usuario en una institución determinada.

📚 Consulta nuestro artículo del DevPortal Evitar enlaces duplicados para obtener más información y consejos sobre cómo usarlo.
    Example: "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c="

  - `results.status` (string)
    El estado actual del enlace. Para más información, consulta nuestro artículo de Link en el devportal. Devolvemos uno de los siguientes valores:
  - 
  - 
  - 
  -
    Enum: "valid", "invalid", "unconfirmed", "token_required"

  - `results.created_by` (string)
    El ID único para el usuario que creó este elemento.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `results.refresh_rate` (string,null)
    La frecuencia de actualización para el enlace recurrente. Para más información, consulta nuestra documentación sobre enlaces recurrentes en nuestro DevPortal.
Devolvemos uno de los siguientes valores de enum:
  - 
  - 
  - 
  -  (predeterminado)
  -  (una vez al mes)
  -  (para enlaces únicos)
    Enum: "6h", "12h", "24h", "7d", "30d", null

  - `results.credentials_storage` (string)
    Indica si se deben almacenar las credenciales (y la duración durante la cual se almacenarán las credenciales).

- Para enlaces recurrentes, esto se establece en  por defecto (y no se puede cambiar).
- Para enlaces únicos, esto se establece en  por defecto.

Puede ser:
  -  para almacenar credenciales (hasta que se elimine el enlace)
  -  para no almacenar credenciales
  - Cualquier valor entre  y  para indicar el número de días que deseas que se almacenen las credenciales.

Para más información, consulta la sección credentials_storage de nuestro artículo sobre controles de retención de datos.
    Example: "27d"

  - `results.fetch_resources` (array)
    Un conjunto de recursos para los que recibirás una actualización histórica.
    Example: ["ACCOUNTS","TRANSACTIONS"]

  - `results.stale_in` (string)
    Indica cuánto tiempo se debe almacenar cualquier dato derivado del usuario en la base de datos de Belvo para el enlace (tanto único como recurrente). Por ejemplo, si envías , Belvo eliminará cualquier dato relacionado con el usuario de su base de datos después de 90 días. Para más información, consulta la sección stale_in de nuestro artículo sobre controles de retención de datos.

> 📘 Info
>
> Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en . Belvo solo eliminará datos para enlaces que no se hayan actualizado en el período que proporciones en .

Por defecto, Belvo almacena los datos del usuario durante 365 días, a menos que el enlace sea eliminado.
    Example: "42d"

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

  - .
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de , la descripción es:

  - .
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

- .
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"