Skip to main content
GET
Listar os documentos de um contato

Authorizations

Authorization
string
header
required

A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.

Query Parameters

limit
integer
default:25

A quantidade de itens da página, de 1 a 100. O padrão é 25.

Required range: 1 <= x <= 100
cursor
string

O valor de next_cursor da página anterior. Sem este parâmetro, a lista começa no item mais novo.

contact_id
string

O id do contato. O id da pessoa começa com per_, e o id da empresa começa com com_.

tax_id
string

O CPF ou o CNPJ do contato, com ou sem pontuação.

collection_id
string

O id de uma coleta. Com este filtro, a lista traz só os documentos da coleta.

Response

Uma página de documentos.

data
object[]
required
has_more
boolean
required

Com true, a lista tem mais itens depois desta página.

next_cursor
string | null
required

O valor do parâmetro cursor para a próxima página. Na última página, o valor é null.