Templates

List templates

List the templates of a workspace.

The status field of a template is one of:

StatusDescription
uploadingThe template is being uploaded.
uploadedThe template has been uploaded.
processingThe template is being processed.
readyThe template is ready to use.
failedThe template processing has failed.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/accounts/{accountId}/templates

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/accounts/{accountId}/templates
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

accountIdstring required

Workspace account ID.

Query parameters

searchstring

Search term.

pageinteger
Example:1

Page number.

per-pageinteger
Example:25

Records per page (max 100).

Response

A page of templates (default_document_tags omitted in the list)

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": [
    {
      "resource": "template",
      "id": "fa88b732db84d01427d4cdd1092",
      "name": "template.pdf",
      "status": "ready",
      "pages": [
        {
          "number": 1,
          "height": 2100,
          "width": 1275
        }
      ],
      "roles": [
        {
          "name": "Editor",
          "assignment_type": "Editor"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 14 revisions of this API.