---
title: "List letters with cursor pagination."
method: GET
path: "/v1/letters"
---

# List letters with cursor pagination.

`GET /v1/letters`

## Request

- Base URL: `https://paperagent.dev`
- URL: `https://paperagent.dev/v1/letters`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://paperagent.dev/oauth/authorize`, token URL `https://paperagent.dev/oauth/token`, scopes: `letters:read`)
  - API key in header `X-Api-Key`
  - HTTP bearer

## Query parameters

- `limit` integer
- `starting_after` string

## Response `200`

Success

- object
  - `letters` object[], required
    - `letter_id` string, required
    - `status` 'pending_payment' | 'pending_moderation' | 'held_for_review' | 'queued' | 'printed' | 'postage_applied' | 'accepted_by_usps' | 'in_transit' | 'arrived_at_destination_facility' | 'expected_delivery' | 'delivered' | 'blocked' | 'cancelled' | 'payment_abandoned' | 'returned', required: Where the letter is. expected_delivery is the last state a standard or proof-of-mailing letter reaches; only certified tiers ever reach delivered.
    - `tier` 'standard' | 'proof_of_mailing' | 'certified' | 'certified_err' | 'registered', required
    - `created_at` string, required
    - `mail_date` string, required
    - `total` object, required: An amount of money. Always read amount_cents; display is for showing the user.
      - `amount_cents` integer, required: The amount in whole US cents.
      - `currency` 'USD', required
      - `display` string, required: The amount formatted for a person, with a currency symbol.
    - `destination_state` string, required
  - `has_more` boolean, required
  - `next_cursor` string, nullable, required

## Other responses

- `default`: A stable error code and actionable message. 401: authenticate; 403: permission or policy; 404: unavailable object; 409: conflict; 422: domain refusal; 429: quota; 5xx: retry or contact support.

---

[API](https://skmtc.dev/paperagent/apis/paperagent-rest-api.md) · [All operations](https://skmtc.dev/paperagent/apis/paperagent-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperagent/apis/paperagent-rest-api/revisions/388148938051?raw)