FIfirma
Templates

List Templates

Changed on

Retrieve a paginated list of templates

get/templates

Request

Query parameters

pageinteger

Page number

page_sizeinteger

Items per page

namestring

Filter by template name (partial match, case-insensitive)

created_afterstring date-time

Filter templates created after this date (ISO 8601 format)

created_beforestring date-time

Filter templates created before this date (ISO 8601 format)

sort_by'name' | 'created_on' | 'last_changed_on'

Field to sort by

sort_order'asc' | 'desc'

Sort order

Response

Templates retrieved successfully

Example response

{
  "results": [
    {
      "fields": [
        {
          "format_rules": {
            "dateFormat": "MMMM dd, yyyy"
          }
        }
      ],
      "documents": [
        {
          "document_id": null,
          "position": 1,
          "label": null,
          "original_filename": null,
          "page_count": 3,
          "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
          "document_url_kind": "stored",
          "document_only_hash": null
        }
      ]
    }
  ]
}

Changes

  • 3a2cdde3a64fRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • bfc2b19c9c7eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status