Documentação

Listar correspondências

Devolve as correspondências da conta, da mais recente para a mais antiga, em páginas.

GET
/letters

Autenticação

apiKey
headerAuthorizationBearer <chave de API>

Chave de API no cabeçalho Authorization: Bearer cf_live_.... Crie e revogue chaves no painel, em Desenvolvedores > Chaves de API.

Parâmetros de consulta

status?string

Só itens neste status.

Valores"scheduled""received""in_production""printed""posted""canceled""failed"
reference?string

Só itens com exatamente esta reference.

limit?integer

Quantos itens devolver por página, de 1 a 100. Padrão: 20.

Intervalo1 <= value <= 100
Padrão20
cursor?string

O next_cursor da página anterior. Omita para buscar a primeira página.

created_after?string

Só itens criados a partir deste momento, inclusive. Data e hora ISO 8601.

Formatodate-time
created_before?string

Só itens criados antes deste momento. Data e hora ISO 8601.

Formatodate-time

Corpo da resposta

Uma página de correspondências.

application/json
  1. response

Uma página de correspondências, da mais recente para a mais antiga.

object*string

Tipo do objeto. Sempre list.

data*array<>

Os itens desta página.

has_more*boolean

true quando existem mais itens depois desta página.

next_cursor*|

Envie este valor em cursor para buscar a próxima página. null quando esta é a última.

curl "https://api.cartaflow.com.br/v1/letters" \  -H "Authorization: Bearer $CARTAFLOW_API_KEY"
{  "object": "list",  "data": [    {      "id": "ltr_8Kq2wX4mN7pR",      "object": "letter",      "status": "posted",      "to": {        "name": "Destinatário Exemplo",        "street": "Praça da Sé",        "number": "128",        "complement": "Ap. 52",        "neighborhood": "Sé",        "city": "São Paulo",        "state": "SP",        "postal_code": "01001-000"      },      "from": {        "name": "Exemplo Serviços Ltda.",        "street": "Avenida Exemplo",        "number": "1000",        "complement": "Sala 301",        "neighborhood": "Bela Vista",        "city": "São Paulo",        "state": "SP",        "postal_code": "01310-100"      },      "document": {        "type": "url",        "url": "https://arquivos.exemplo.com.br/faturas/2026-10-0042.pdf",        "variables": null      },      "color": true,      "double_sided": false,      "address_placement": "first_page",      "postal_services": [],      "pages": 2,      "sheets": 2,      "price": {        "currency": "BRL",        "total": 1135,        "items": [          {            "type": "base",            "quantity": 1,            "unit_amount": 990,            "amount": 990          },          {            "type": "additional_sheets",            "quantity": 1,            "unit_amount": 75,            "amount": 75          },          {            "type": "color",            "quantity": 2,            "unit_amount": 35,            "amount": 70          }        ]      },      "send_date": null,      "cancellation_reason": null,      "failure_reason": null,      "tracking_code": null,      "preview_url": "https://files.cartaflow.com.br/previews/ltr_8Kq2wX4mN7pR.pdf?expires=1760369400&signature=9c1f2a7d",      "reference": "fatura-2026-10-0042",      "metadata": {        "customer_id": "1842"      },      "status_transitions": {        "received_at": "2026-10-13T14:20:00Z",        "in_production_at": "2026-10-13T21:00:00Z",        "printed_at": "2026-10-14T10:42:00Z",        "posted_at": "2026-10-14T16:05:00Z",        "canceled_at": null,        "failed_at": null      },      "created_at": "2026-10-13T14:20:00Z"    }  ],  "has_more": false,  "next_cursor": null}