curl --request GET \
--url https://app.useqx.com/api/v1/collections \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/collections"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.useqx.com/api/v1/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.useqx.com/api/v1/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/collections"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useqx.com/api/v1/collections")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "col_40",
"protocol": "DOC-2026-00123",
"state": "assembling",
"discarded": false,
"contact": {
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda"
},
"recipient": null,
"packs": [
{
"id": "pck_12",
"name": "Importação marítima"
}
],
"numbers": [
"INV-81244/2026"
],
"created_at": "2026-09-25T10:31:12.000-03:00",
"ready_at": null
}
],
"has_more": true,
"next_cursor": "WyIyMDI2LTA5LTI1VDEzOjMxOjEyLjAwMDAwMFoiLDQwXQ"
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "O parâmetro limit tem um valor inválido.",
"code": "invalid_parameter"
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer <chave>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo.",
"code": "rate_limited"
}Listar as coletas
Lista as coletas da organização da chave, da coleta mais nova à mais antiga. A lista não traz a coleta arquivada. GET /collections/{id} mostra a coleta arquivada, com discarded igual a true. Cada filtro reduz a lista, e os filtros valem juntos.
curl --request GET \
--url https://app.useqx.com/api/v1/collections \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.useqx.com/api/v1/collections"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.useqx.com/api/v1/collections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.useqx.com/api/v1/collections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.useqx.com/api/v1/collections"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.useqx.com/api/v1/collections")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.useqx.com/api/v1/collections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "col_40",
"protocol": "DOC-2026-00123",
"state": "assembling",
"discarded": false,
"contact": {
"id": "com_12",
"type": "company",
"name": "Importadora Exemplo Ltda"
},
"recipient": null,
"packs": [
{
"id": "pck_12",
"name": "Importação marítima"
}
],
"numbers": [
"INV-81244/2026"
],
"created_at": "2026-09-25T10:31:12.000-03:00",
"ready_at": null
}
],
"has_more": true,
"next_cursor": "WyIyMDI2LTA5LTI1VDEzOjMxOjEyLjAwMDAwMFoiLDQwXQ"
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "O parâmetro limit tem um valor inválido.",
"code": "invalid_parameter"
}{
"type": "about:blank",
"title": "Unauthorized",
"status": 401,
"detail": "A chamada não trouxe uma chave de API válida. Envie a chave no cabeçalho Authorization, no formato Bearer <chave>.",
"code": "unauthorized"
}{
"type": "about:blank",
"title": "Payment Required",
"status": 402,
"detail": "A assinatura da organização está bloqueada. Regularize o pagamento no QX para usar a API.",
"code": "subscription_blocked"
}{
"type": "about:blank",
"title": "Forbidden",
"status": 403,
"detail": "O plano gratuito não inclui a API. Assine um plano pago no QX para usar a API.",
"code": "plan_required"
}{
"type": "about:blank",
"title": "Too Many Requests",
"status": 429,
"detail": "A chave passou de um limite por minuto. Espere os segundos do cabeçalho Retry-After e chame de novo.",
"code": "rate_limited"
}Authorizations
A chave de API da organização, no cabeçalho Authorization: Bearer <chave>. A chave começa com qx_.
Query Parameters
A quantidade de itens da página, de 1 a 100. O padrão é 25.
1 <= x <= 100O valor de next_cursor da página anterior. Sem este parâmetro, a lista começa no item mais novo.
O id do contato da coleta. O id da pessoa começa com per_, e o id da empresa começa com com_.
O CPF ou o CNPJ do contato da coleta, com ou sem pontuação.
A primeira data de criação, no formato AAAA-MM-DD. A data usa o fuso horário da organização, e o dia inteiro entra na lista.
A última data de criação, no formato AAAA-MM-DD. A data usa o fuso horário da organização, e o dia inteiro entra na lista.
O estado da coleta. O campo state da coleta explica cada valor.
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.
assembling, reviewing, ready_to_dispatch, awaiting_partner, cancelled O id do pacote que a coleta pede. A coleta sem contato também entra na lista, antes de o destinatário se identificar.
O protocolo da coleta, ou um número impresso num documento da coleta, como o número da fatura. A busca ignora a diferença entre maiúscula e minúscula. A busca não acha a coleta pelo número que um documento só cita.