List documents
The workspace's document inventory, newest first. Every upload appears, including one that has no envelope yet, so a document an agent left behind stays rediscoverable. Each row carries the envelope built from the document when one exists, plus the signer and signed counts for that envelope. Only public ids are returned: storage keys and internal row ids are never exposed. Ordering is createdAt descending with the internal id breaking ties, so a row cannot appear on two pages of one walk or be skipped between them.
Request
- Base URL: https://inkseal.net/api/v1
- URL: https://inkseal.net/api/v1/documents
- Auth: HTTP bearer
Query parameters
1-based page number.
Items per page.
Case-insensitive substring match on the original filename. % and _ are literal characters, not wildcards. A value that trims to nothing is treated as absent.
Filter by the status of the envelope built from the document. none selects documents that have no envelope at all, all applies no filter. Every other value narrows to a real envelope status, which excludes envelope-less uploads by construction.
Filter by how the document's envelope was created.
Archived envelopes are hidden unless asked for. active excludes them, only returns just them, all applies no filter.
Response
A page of documents.
Example response
{
"data": [
{
"id": "V1StGXR8_Z5jdHi6B-myT",
"status": "ready",
"originalFilename": "master-services-agreement.pdf",
"originalMimeType": "application/pdf",
"originalSizeBytes": 184320,
"pageCount": 12,
"envelope": {
"id": "kM2xQ7pLbV9tRw4sZ0aYc",
"status": "pending",
"createdVia": "api"
},
"signerCount": 2,
"signedCount": 1,
"completedCount": 1,
"createdAt": "2026-08-21T14:03:11.482Z",
"updatedAt": "2026-08-21T14:04:02.117Z"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.