List letters
Returns the account’s letters, newest first, one page at a time.
apiKeyAuthorizationBearer <token>API key in the Authorization: Bearer cf_live_... header. Create and revoke keys in the dashboard, under Desenvolvedores > Chaves de API (Developers > API keys).
status?stringOnly items in this status.
"scheduled""received""in_production""printed""posted""canceled""failed"reference?stringOnly items with exactly this reference.
limit?integerHow many items to return per page, from 1 to 100. Default: 20.
1 <= value <= 10020cursor?stringThe next_cursor of the previous page. Leave it out to fetch the first page.
created_after?stringOnly items created at or after this moment. ISO 8601 date and time.
date-timecreated_before?stringOnly items created before this moment. ISO 8601 date and time.
date-timeA page of letters.
application/json- response
A page of letters, newest first.
object*stringObject type. Always list.
data*array<>The items on this page.
has_more*booleantrue when there are more items after this page.
next_cursor*|Send this value as cursor to fetch the next page. null when this is the last page.
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}