API referenceLetters
List letter templates
List letter templates (most recent first)
Returns the account's letter templates, newest first, up to 100 in one response (no cursor). List items omit the html body to keep the payload small — fetch a single template to read it. Requires the letters:read scope.
Scope: letters:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Response
200 Success. Body: application/json, LetterTemplateList.
| Field | Type | Required | Description |
|---|---|---|---|
object | "list" | yes | |
data | array of LetterTemplate | yes | |
pagination | Pagination | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |