Skip to main content
GET
List the collections

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 collection's contact. A person id starts with per_, and a company id starts with com_.

tax_id
string

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

created_from
string<date>

The first creation date, in the YYYY-MM-DD format. The date uses the time zone of the organization, and the list includes the whole day.

created_to
string<date>

The last creation date, in the YYYY-MM-DD format. The date uses the time zone of the organization, and the list includes the whole day.

state
enum<string>

The state of the collection. The state field of the collection explains each value. The state of the collection. assembling: the collection is in assembly and waits for the documents. reviewing: the operator reviews the documents. ready_to_dispatch: every required document arrived, and no validation blocks the collection. awaiting_partner: the operator sent the collection to the partner. cancelled: the operator canceled the collection.

Available options:
assembling,
reviewing,
ready_to_dispatch,
awaiting_partner,
cancelled
pack_id
string

The id of a pack that the collection asks for. The list also includes a collection without a contact, before the recipient identifies themselves.

number
string

The protocol of the collection, or a number printed on a document of the collection, such as the invoice number. The search ignores the difference between uppercase and lowercase. The search does not find a collection by a number that a document only cites.

Response

A page of collections.

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.