Letters Events
letters_eventsRetrieve a paginated collection of events for a specific letter and organisation, with query filters, sorting, pagination, and field selection.
Instructions
Get a collection of letter events. GET /organisations/{organisationId}/deliveries/letters/{letterId}/events
Paginated collection. page_number maps to page[number] and
page_limit to page[limit]; query keys (language, sort, filter,
q, include, fields[...]) pass through verbatim.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"organisation_id": "<organisation_id>",
"letter_id": "<letter_id>"
},
"name": "letters_events"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | ||
| letter_id | Yes | ||
| page_limit | No | ||
| page_number | No | ||
| organisation_id | Yes |