API referenceLetters

List a letter's delivery events

Returns the letter's delivery timeline as letter_event objects, newest first, capped at the 100 most recent.

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

Returns the letter's delivery timeline as letter_event objects, newest first, capped at the 100 most recent. Each event carries a type in the same vocabulary as the letter status (for example in_transit or delivered), plus optional code, description, location, and occurredAt/recordedAt timestamps. The same timeline is embedded as events on GET /v1/letters/{id}, so a separate call is only needed when you want events without the letter. Responds 404 when the letter id is unknown.

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/3fa85f64-5717-4562-b3fc-2c963f66afa6/events" \
  -H "Authorization: Bearer $DAIRO_API_KEY"

Path parameters

NameTypeRequiredDescription
idstringyesThe letter's ID.

Query parameters

NameTypeRequiredDescription
limitintegernoMaximum number of items in the page. (minimum 1, maximum 100, default 25)
cursorstringnoThe nextCursor of the previous page; omit it for the first page (Pagination).

Response

200 Success. Body: application/json, LetterEventList.

FieldTypeRequiredDescription
object"list"yes
dataarray of LetterEventyes
paginationPaginationyes
200
{
  "object": "list",
  "data": [
    {
      "object": "letter_event",
      "eventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "letterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "code": null,
      "description": null,
      "producer": null,
      "location": null,
      "reason": null,
      "hasImage": true,
      "occurredAt": "2026-10-19T09:30:00Z",
      "recordedAt": "2026-10-19T09:30:00Z"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}

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