Skip to main content
GET
List physical-mail letters (paginated)

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string
status
enum<string>
Available options:
draft,
queued,
processing,
printable,
submitted,
in_transit,
delivered,
undeliverable,
canceled,
failed
country
string
batchId
string

Filter to the member letters of one batch (the id returned by POST /v1/letters/batches).

Response

Success

object
enum<string>
required
Available options:
list
data
object[]
required
pagination
object
required