# Listar links

## ▶️ Uso

Com o método List Links, você pode:

1. Listar todos os links relacionados à sua conta Belvo (sem usar parâmetros de consulta).
2. Obter os detalhes de um link.id específico (usando o parâmetro de consulta id).

## 📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

## 🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, veja nosso artigo Filtrando respostas.

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

## Query parameters:

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

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

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

  - `id` (string)
    Retorne informações apenas para este recurso id.
    Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f"

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `institution` (string)
    Retorne resultados apenas para esta instituição (use o nome designado pela Belvo, como planet_mx_employment).
    Example: "planet_mx_retail"

  - `institution__in` (array)
    Retorne resultados apenas para estas instituições (use os nomes designados pela Belvo, como ofmockbank_br_retail e planet_mx_employment).
    Example: ["planet_mx_retail"]

  - `access_mode` (string)
    Retorne links apenas com este modo de acesso. Pode ser single ou recurrent.
    Enum: "single", "recurrent"

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

  - `created_by__not_in` (array)
    Retorne links que não foram criados por esses usuários da Belvo.
    Example: ["d9475f4d-c511-4732-9ef0-93b5672f43d3"]

  - `external_id` (string)
    Retorne links com este ID externo.
    Example: "InternalUser4000"

  - `external_id__in` (array)
    Retorne links com esses IDs externos.
    Example: ["InternalUser4001"]

  - `institution_user_id` (string)
    Retorne links com este ID de usuário específico da instituição.
    Example: "ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0="

  - `institution_user_id__in` (array)
    Retorne links com esses IDs de usuário da instituição.
    Example: ["ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0="]

  - `refresh_rate` (string)
    Retorne links com esta taxa de atualização. Escolha entre 6h, 12h, 24h, 7d, 30d ou null (para links únicos).
    Example: "24h"

  - `status` (string)
    Retorne links com este status. Escolha entre valid, invalid, unconfirmed ou token_required.
    Example: "invalid"

  - `status__in` (array)
    Retorne links com esses status. Escolha entre valid, invalid, unconfirmed ou token_required.
    Example: ["invalid"]

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Array de objetos de link.

  - `results.id` (string)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.institution` (string)
    Nome da instituição segundo a Belvo.
    Example: "erebor_mx_retail"

  - `results.access_mode` (string,null)
    O tipo de link. Para mais informações, consulte nosso artigo de Links. Retornamos um dos seguintes valores enum: - single - recurrent - null
    Enum: "single", "recurrent", null

  - `results.last_accessed_at` (string,null)
    O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
    Example: "2021-03-09T10:28:40.000Z"

  - `results.created_at` (string)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.external_id` (string)
    Um identificador adicional para o link, fornecido por você, para armazenar no banco de dados da Belvo. Não pode incluir nenhuma Informação Pessoal Identificável (PII). Deve ter pelo menos três caracteres.

Se identificarmos que o identificador contém PII, forçaremos um valor null. Para mais informações, consulte nosso artigo sobre criação de links.
    Example: "56ab5706-6e00-48a4-91c9-ca55968678d9"

  - `results.institution_user_id` (string)
    > 📘 Info
>
> Aplicável apenas para links criados após 08-02-2022.

Uma string única de 44 caracteres que pode ser usada para identificar um usuário em uma determinada instituição.

📚 Confira nosso artigo no DevPortal sobre como evitar links duplicados para mais informações e dicas sobre como usá-la.
    Example: "sooE7XJWEKypZJR603ecaWYk-8Ap0oD8Nr1pBQ4eG9c="

  - `results.status` (string)
    O status atual do link. Para mais informações, consulte nosso artigo sobre Link no devportal.  
Retornamos um dos seguintes valores:  
  - valid  
  - invalid  
  - unconfirmed  
  - token_required
    Enum: "valid", "invalid", "unconfirmed", "token_required"

  - `results.created_by` (string)
    O ID único para o usuário que criou este item.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `results.refresh_rate` (string,null)
    A taxa de atualização para o link recorrente. Para mais informações, consulte nossa documentação de links recorrentes em nosso DevPortal.
Retornamos um dos seguintes valores de enum:
  - 6h
  - 12h
  - 24h
  - 7d (padrão)
  - 30d (uma vez por mês)
  - null (para links únicos)
    Enum: "6h", "12h", "24h", "7d", "30d", null

  - `results.credentials_storage` (string)
    Indica se as credenciais devem ou não ser armazenadas (e a duração para a qual as credenciais serão armazenadas).

- Para links recorrentes, isso é definido como store por padrão (e não pode ser alterado).
- Para links únicos, isso é definido como 365d por padrão.

Pode ser:
  - store para armazenar credenciais (até que o link seja excluído)
  - nostore para não armazenar credenciais
  - Qualquer valor entre 1d e 365d para indicar o número de dias que você deseja que as credenciais sejam armazenadas.

Para mais informações, confira a seção credentials_storage do nosso artigo sobre controles de retenção de dados.
    Example: "27d"

  - `results.fetch_resources` (array)
    Um array de recursos para o qual você receberá uma atualização histórica.
    Example: ["ACCOUNTS","TRANSACTIONS"]

  - `results.stale_in` (string)
    Indica por quanto tempo qualquer dado derivado do usuário deve ser armazenado no banco de dados da Belvo para o link (tanto único quanto recorrente). Por exemplo, se você enviar 90d, a Belvo removerá qualquer dado relacionado ao usuário de seu banco de dados após 90 dias. Para mais informações, confira a seção stale_in do nosso artigo sobre controles de retenção de dados.

> 📘 Informação
>
> A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in. A Belvo removerá dados apenas para links que não foram atualizados no período que você fornecer em stale_in.

Por padrão, a Belvo armazena dados do usuário por 365 dias, a menos que o link seja deletado.
    Example: "42d"

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

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

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

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

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    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)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"