Documentation

Documents

List generated documents

GET/generations

The workspace's generated documents, newest first. Filters combine with AND.

Parameters

NameTypeDescription
templateuuidOnly documents generated from this template.
created_byuuidOnly documents generated by this user.
sourceapp | apiapp for documents generated in PaperClerk, api for the API and the MCP connector.
fromdate-timeOnly documents created at or after this instant. ISO 8601; a date alone means midnight UTC.
todate-timeOnly documents created before this instant. The window is half-open: from is included, to is not.
searchstringOnly documents whose title contains this text.
limitintegerPage size, 1 to 200.
cursorstringThe next_cursor of the previous page.

Request

curl "https://usepaperclerk.com/api/v1/generations?template=4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f&from=2026-09-01&limit=2" \
  -H "Authorization: Bearer pc_YOUR_TOKEN"

Response

JSON
{
  "generations": [
    {
      "id": "9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b",
      "template_id": "4d1f0c2e-7b3a-4c1e-9d2f-1a2b3c4d5e6f",
      "template_title": "Consulting invoice",
      "title": "Invoice — Maple & Fern, September",
      "generation_number": 13,
      "source": "api",
      "source_version": 3,
      "created_by": "7e6d5c4b-3a2f-4e1d-9c8b-7a6f5e4d3c2b",
      "created_by_name": "Mara Novak",
      "created_at": "2026-09-12T14:02:11.480Z",
      "pdf_status": "ready",
      "pdf_url": "https://usepaperclerk.com/api/v1/generations/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b/pdf",
      "url": "https://usepaperclerk.com/app/generated/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b"
    },
    { "…": "…" }
  ],
  "total": 27,
  "has_more": true,
  "next_cursor": "MjAyNi0wOS0xMlQxNDowMDowNS4wMDBafDliOGUyZjEw…"
}
  • template_id is null once the template has been deleted; the document and template_title survive.
  • The document's number within its template; source_version is the saved version it was generated from.
  • next_cursor is null on the last page.
  • total counts every document matching the filters, whatever the page size.
  • created_by_name is the person's display name; null when the workspace no longer shares it.