Events

Query the events Paperarchive extracts from documents - invoices, contracts, policies, notices, and more - including state, amount, and due date. Ideal for questions like "What is open or due?".

GET https://api.paperarchive.io/v1/events

Scope:events:read

List events extracted from documents. Each event carries a state (e.g. "open", "paid", "active"), an optional amount, and an optional due date, and links to its source document. Events are visible when their linked document is in an accessible space; events without a document are not returned.

Query parameters

Name	Type	Required	Description
`state`	string	optional	Filter by state: received, needs_input, open, paid, expired, cancelled, archived, active.
`event_type`	string	optional	Filter by type: invoice, offer, credit_note, statement, contract, policy, notice, receipt, payslip, letter.
`due_before`	date (YYYY-MM-DD)	optional	Only events with a due date on or before this date.
`due_after`	date (YYYY-MM-DD)	optional	Only events with a due date on or after this date.
`space_id`	uuid	optional	Only events whose document is in this space.
`document_id`	uuid	optional	Only events attached to this document.
`limit`	integer	optional	Maximum number of events to return (1-100). Default: `25`
`offset`	integer	optional	Pagination offset. Default: `0`

Code examples

curl -X GET "https://api.paperarchive.io/v1/events?state=open&due_before=2026-09-30" \
  -H "Authorization: Bearer pa_live_abc123def456"

GET https://api.paperarchive.io/v1/events/:id

Scope:events:read

Retrieve a single event by ID, including amounts, deadlines, reference number, sender, and the linked source document.

Path parameters

Name	Type	Required	Description
`id`	uuid	required	The event ID.

Code examples

curl -X GET "https://api.paperarchive.io/v1/events/e1f2a3b4-c5d6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer pa_live_abc123def456"