LATAM

Busca por documentos LATAM

Disponível somente em ambiente de produção.

Este endpoint permite a busca por documentos do tipo LATAM que tenham sido previamente enviados pelo endpoint /v1/latam/upload.

O retorno deste endpoint é uma lista de documentos em formato unificado em padrão QIVE LATAM.

Sempre que houver uma nova página disponível dentro do filtro realizado, o parâmetro page.next estará presente no JSON de retorno. Ao atingir a última página, este parâmetro deixará de ser retornado, indicando que todas as páginas disponíveis foram consultadas.

Para habilitar esse recurso, entre em contato com o gerente da sua conta ou com nosso time de atendimento.

get/v1/latam/search

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/latam/search
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Query parameters

initial_datestring date-time required

Data inicial para o filtro de busca. Esta data se refere à data em que o documento foi ingerido ou atualizado na Qive. Utilize o formato: 2025-01-23T00:00:00Z ou 2025-01-23T00:00:00.000Z.

final_datestring date-time required

Data final para o filtro de busca. Esta data se refere à data em que o documento foi ingerido ou atualizado na Qive. Utilize o formato: 2025-01-23T00:00:00Z ou 2025-01-23T00:00:00.000Z.

pageinteger required

Página que deve ser buscada pela API. Cada página retorna um total de até 25 documentos.

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Response

Successful fetch

Changes

No recorded changes to this operation across all 1 revision of this API.