Skip to main content
GET
List letters

Authorizations

Authorization
string
header
default:aro_sk_your_key_here
required

AroPay API key, sent as Authorization: Bearer aro_sk_…. Created in the dashboard under Settings → API keys. Takes precedence over a session cookie when both are present.

Query Parameters

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:20
Required range: 1 <= x <= 100
status
enum<string>

Filter by letter status.

Available options:
DRAFT,
ESCROWED,
MAILED,
CLAIMING,
CLAIMED,
EXPIRED,
VOIDED,
FAILED

Response

A page of letters.

ok
any
required
data
object
required