curl https://thepostalcompany.com/api/v1/letters \
-H "Authorization: Bearer tpc_your_api_key"
const response = await fetch("https://thepostalcompany.com/api/v1/letters", {
headers: { "Authorization": "Bearer tpc_your_api_key" },
});
const { letters } = await response.json();
console.log(`You have ${letters.length} letters`);
{
"letters": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "sent",
"recipient": "Jane Doe",
"address": {
"street": "Keizersgracht",
"number": "123",
"postalcode": "1015 CJ",
"city": "Amsterdam",
"country": "NL"
},
"content": "Dear Jane,\n\nHello!\n\nBest regards",
"created_at": "2026-04-14T10:00:00.000Z",
"updated_at": "2026-04-14T10:00:05.000Z"
}
]
}
Letters
List Letters
List all letters for your account.
GET
/
api
/
v1
/
letters
curl https://thepostalcompany.com/api/v1/letters \
-H "Authorization: Bearer tpc_your_api_key"
const response = await fetch("https://thepostalcompany.com/api/v1/letters", {
headers: { "Authorization": "Bearer tpc_your_api_key" },
});
const { letters } = await response.json();
console.log(`You have ${letters.length} letters`);
{
"letters": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "sent",
"recipient": "Jane Doe",
"address": {
"street": "Keizersgracht",
"number": "123",
"postalcode": "1015 CJ",
"city": "Amsterdam",
"country": "NL"
},
"content": "Dear Jane,\n\nHello!\n\nBest regards",
"created_at": "2026-04-14T10:00:00.000Z",
"updated_at": "2026-04-14T10:00:05.000Z"
}
]
}
List Letters
Retrieve all letters belonging to your account, ordered by most recently updated first.Response
array
An array of letter objects.
Examples
curl https://thepostalcompany.com/api/v1/letters \
-H "Authorization: Bearer tpc_your_api_key"
const response = await fetch("https://thepostalcompany.com/api/v1/letters", {
headers: { "Authorization": "Bearer tpc_your_api_key" },
});
const { letters } = await response.json();
console.log(`You have ${letters.length} letters`);
{
"letters": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"status": "sent",
"recipient": "Jane Doe",
"address": {
"street": "Keizersgracht",
"number": "123",
"postalcode": "1015 CJ",
"city": "Amsterdam",
"country": "NL"
},
"content": "Dear Jane,\n\nHello!\n\nBest regards",
"created_at": "2026-04-14T10:00:00.000Z",
"updated_at": "2026-04-14T10:00:05.000Z"
}
]
}
Error codes
| Status | Description |
|---|---|
401 | Missing, invalid, or revoked API key |
