Pluma — Templates API — list, read and update PDF templates

GET/api/v1/:workspace/templates

List templates

Paginated list of templates in a workspace. Returns the standard {templates, meta} envelope; default sort is updatedAt:desc.

Parameters

`workspace`path	Workspace slug.required
`active`query	true \| false
`folder`query	Exact folder match. Use "null" for unfoldered.
`q`query	Case-insensitive substring on name.
`limit`query	1 – 100 (default 50)
`offset`query	Rows to skip (default 0).
`sortBy`query	createdAt \| updatedAt \| name, suffixed with :asc or :desc.
`totalResults`query	true to include meta.total.

Response

{
  "templates": [
    {
      "id": "…",
      "workspaceId": "…",
      "name": "Invoice",
      "fields": [
        "…"
      ],
      "active": true,
      "folder": "invoices",
      "updatedAt": "…"
    }
  ],
  "meta": {
    "count": 1,
    "limit": 50,
    "offset": 0,
    "hasMore": false
  }
}

GET/api/v1/:workspace/templates/:id

Get one template

Full template metadata including field placements, schema linkage, and render-time validation switches. See the Schemas section below for what schemaId / jsonSchema / validateData / allowAdditionalData control.

Parameters

`workspace`path	Workspace slug.required
`id`path	Template UUID.required

Response

{
  "id": "…",
  "name": "Invoice",
  "fields": [
    "…"
  ],
  "schemaId": "…",
  "jsonSchema": null,
  "validateData": false,
  "allowAdditionalData": false,
  "active": true
}

PATCH/api/v1/:workspace/templates/:id

Update a template

Partial update — send only the fields you want to change; everything else is left as-is. Accepts the same fields as create: name, description, folder, active, fields, schemaId, jsonSchema, validateData, allowAdditionalData, renderer, encryptPassword (null clears it), apiCanSetPassword. Design changes (fields, schema linkage, the default font) create a new template version; settings-only changes don't.

Parameters

`workspace`path	Workspace slug.required
`id`path	Template UUID.required

Response

{
  "id": "…",
  "name": "Invoice v2",
  "fields": [
    "…"
  ],
  "active": true
}

Need help?

Open a ticket from the in-app Support page, or email [email protected].