Pingen icon

Pingen

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

Letter Event → Get Undeliverable

AI-generated

Summary

Lists undeliverable letter events for the selected Pingen organisation. Choose the production or staging environment and organisation; optionally set pagination, sorting, or filters to narrow the results.

Inputs

  • Environment — Pingen environment to use: production (default) or staging. Each uses its corresponding credentials.
  • Organisation Name or ID (required) — Organisation whose undeliverable letter events to list; select an organisation or provide its ID.
  • Page Number — 1-based page number. The default 0 leaves page selection to the server.
  • Page Size — Items per page, from 0 to 100. The default 0 leaves page size to the server.
  • Sort — Optional JSON:API sort expression; comma-separate fields and prefix a field with - for descending order.
  • Additional Filters — Optional key/value filters appended as filter[key]=value to the request.

Output shape

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

Each item includes its id, type, and event attributes. The response may also include pagination metadata, links, and errors when present in the API response.

Links

Discussion