EaserixDocs
DevelopersAPI referenceSignTemplates

List templates

Public templates plus the caller's own, ordered by usageCount descending. category, q and ids are optional filters. The result is paged only when limit or offset is sent (default 10, capped at 100); without either, every matching template is returned, up to 1000, and limit reports how many came back (total > that count means the list was cut off). categories always describes the full readable set regardless of the filters or page applied, so the category chips never depend on what the current page shows; total counts what the filters match, ignoring the page.

View as Markdown
GET
/v1/templates

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

category?string

Exact category name, or "Uncategorised" for templates with none.

q?string

Case-insensitive substring match against name, description or category. "%" and "_" match literally.

ids?string

Comma-separated template ids (at most 100) to narrow to. Ids outside the caller's readable set are silently absent from the result.

limit?integer

Page size, default 10, capped at 100. Omit both limit and offset to get every matching template unpaged (up to 1000).

offset?integer

Page start. Default 0. Sending it alone pages at the default size.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/templates"
{  "templates": [    {      "id": "string",      "name": "string",      "description": "string",      "category": "string",      "created": "2019-08-24T14:15:22Z",      "modified": "2019-08-24T14:15:22Z",      "usageCount": 0,      "isPublic": true,      "hasFile": true,      "pages": 0,      "content": {        "sections": [          {            "heading": "string",            "body": "string"          }        ],        "placeholders": [          {            "key": "string",            "label": "string",            "hint": "string"          }        ]      },      "visibility": "string",      "ownerId": "string",      "recipients": [        {          "name": "string",          "role": "string",          "orderIndex": 0,          "isGroup": true,          "groupLabel": "string"        }      ],      "fields": [        {          "type": "signature",          "x": 0,          "y": 0,          "width": 0,          "height": 0,          "page": 0,          "required": true,          "label": "string",          "recipientIndex": 0,          "key": "string",          "config": {}        }      ]    }  ],  "total": 0,  "categories": [    {      "name": "string",      "count": 0    }  ],  "limit": 0,  "offset": 0}

Snapshot a document as a template

Snapshots recipients ({name, role, orderIndex}) and fields (geometry without values; per-signer assignment survives as recipientIndex) into a private template. name defaults to the document's name; category defaults to "Other".

Create a template

Creates a private template; recipients/fields are stored as opaque JSON arrays.