Skip to main content
GET
Ler uma coleta

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

O id da coleta. O id começa com col_.

Response

A coleta, com os documentos.

Uma coleta, com a lista de documentos.

id
string
required

O id da coleta.

Pattern: ^col_[1-9][0-9]*$
Example:

"col_40"

protocol
string
required

O protocolo da coleta.

Example:

"DOC-2026-00123"

state
enum<string>
required

O estado da coleta. assembling: a coleta está em montagem e espera os documentos. reviewing: o operador revisa os documentos. ready_to_dispatch: todo documento obrigatório chegou, e nenhuma validação bloqueia a coleta. awaiting_partner: o operador enviou a coleta ao parceiro. cancelled: o operador cancelou a coleta.

Available options:
assembling,
reviewing,
ready_to_dispatch,
awaiting_partner,
cancelled
discarded
boolean
required

Com true, a coleta está arquivada.

contact
object | null
required

O contato da coleta. O valor é null na coleta sem contato, até o destinatário se identificar.

recipient
object | null
required

O destinatário da coleta criada sem contato. Na coleta criada com contato, o valor é null.

packs
object[]
required

Os pacotes que a coleta pede.

numbers
string[]
required

Os números da operação, como a tela da coleta mostra. A lista traz os números impressos nos documentos dos requisitos identificadores do pacote. Sem esses números, a lista traz os números impressos nos outros documentos da coleta. Na coleta sem pacote de operação, a lista é vazia.

Example:
created_at
string<date-time>
required

A data e a hora da criação, no fuso horário da organização.

Example:

"2026-09-25T10:30:00.000-03:00"

ready_at
string<date-time> | null
required

A data e a hora em que a coleta ficou pronta pela última vez, no fuso horário da organização. O valor é null quando a coleta nunca ficou pronta.

documents
object[]
required

Os documentos da coleta, do mais antigo ao mais novo. O documento descartado fica de fora.