Skip to main content
GET
List the documents of a contact

Authorizations

Authorization
string
header
required

The API key of the organization, in the Authorization: Bearer <key> header. The key starts with qx_.

Query Parameters

limit
integer
default:25

The number of items on the page, from 1 to 100. The default is 25.

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

The next_cursor value of the previous page. Without this parameter, the list starts at the newest item.

contact_id
string

The id of the contact. A person id starts with per_, and a company id starts with com_.

tax_id
string

The CPF or the CNPJ of the contact, with or without punctuation.

collection_id
string

The id of a collection. With this filter, the list includes only the documents of the collection.

Response

A page of documents.

data
object[]
required
has_more
boolean
required

With true, the list has more items after this page.

next_cursor
string | null
required

The value of the cursor parameter for the next page. On the last page, the value is null.