Skip to main content
List documents

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as document.id. Fields: document, category, provenance, submitted_source, invoice_attachment, historical_version.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
category
enum<string>
Available options:
invoice,
agreement,
other
Maximum string length: 255
previous_version_id
string<uuid>
sort
enum<string>
default:created_at
Available options:
created_at,
file_name,
file_size,
page_count
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of documents; next_cursor is null at the end.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required