API referenceLetters

Get one letter template

Get one letter template (with its full HTML body)

Endpoint
GET https://api.dairo.app/v1/letters/templates/{id}

Returns a single letter_template, including the full html body that list items omit. Responds 404 when the id does not exist or belongs to another account. Requires the letters:read scope.

Scope: letters:read. Send the API key as a bearer token; Scopes lists what each one reaches.

Request

cURL
curl "https://api.dairo.app/v1/letters/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $DAIRO_API_KEY"

Path parameters

NameTypeRequiredDescription
idstringyesThe letter template's ID.

Response

200 Success. Body: application/json, LetterTemplate.

FieldTypeRequiredDescription
object"letter_template"yes
idstringyes
namestringyes
htmlstringnoThe branded letter HTML with {{placeholders}} and a blank recipient address window. Omitted from list items.
variablesarray of LetterTemplateVariablenoDeclared template variables, stored and returned as [{name, type?, example?, label?}].
statusLetterTemplateStatusyes
createdAtstring (date-time) or nullno
updatedAtstring (date-time) or nullno
200
{
  "object": "letter_template",
  "id": "string",
  "name": "Ada Lovelace",
  "html": "string",
  "variables": [
    {
      "name": "Ada Lovelace",
      "type": "string",
      "example": "string",
      "label": "production"
    }
  ],
  "status": "active",
  "createdAt": "2026-10-19T09:30:00Z",
  "updatedAt": "2026-10-19T09:30:00Z"
}

Errors

Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.

StatusMeaning
400The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch).
401The API key is missing or invalid.
403The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted).
404No such resource in this account (resource_not_found).
422The request is well-formed but a field failed validation (validation_failed).
429Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached).
500An unexpected error; retry with backoff, then contact support (internal_error).

On this page