Pingen icon

Pingen

Send physical postal letters through the Pingen API — invoices, reminders, contracts, any PDF.

Actions18

Letter Event → Get for Letter

AI-generated

Summary

Fetches the events for a specified letter from the selected Pingen organisation and environment. Supports paging, sorting, and additional filters on the request.

Inputs

  • Environment — Choose Production or Staging; each uses its corresponding Pingen credentials. Defaults to Production.
  • Organisation Name or ID (required) — Select the Pingen organisation or provide its ID with an expression.
  • Letter ID (required) — UUID of the letter whose events to fetch.
  • Page Number — Page number; 0 uses the server default. Defaults to 0.
  • Page Size — Items per page, from 0 to 100; 0 uses the server default. Defaults to 0.
  • Sort — Optional JSON:API sort expression, such as -created_at,name.
  • Additional Filters — Optional key/value pairs sent as filter[key]=value query parameters.

Output shape

A single JSON object containing an items array of letter events and a total count.

Each event includes its id, type, and flattened attributes. The response may also include pagination metadata, links, or errors when supplied by the API.

Links

Discussion