Skip to main content
GET
/
templates
List Templates
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "document_url": "<string>",
      "document_url_expires_at": "2023-11-07T05:31:56Z",
      "page_count": 2,
      "expiration_hours": 168,
      "credit_cost": 1,
      "settings": {
        "allow_download": true,
        "attach_pdf_on_finish": true,
        "allow_editing_before_sending": false,
        "use_signing_order": false,
        "hand_drawn_only": false,
        "send_signing_email": true,
        "send_finish_email": true,
        "send_expiration_email": true,
        "send_cancellation_email": true
      },
      "recipients": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "jsmith@example.com",
          "first_name": "<string>",
          "last_name": "<string>",
          "designation": "Signer",
          "order": 2,
          "phone_number": "<string>",
          "street_address": "<string>",
          "city": "<string>",
          "state_province": "<string>",
          "postal_code": "<string>",
          "country": "<string>",
          "title": "<string>",
          "company": "<string>",
          "required_fields": [
            "<string>"
          ],
          "missing_fields": [
            "<string>"
          ],
          "required_read_only_fields": [
            {
              "variable_name": "<string>",
              "field_type": "<string>"
            }
          ],
          "ready_to_send": true
        }
      ],
      "fields": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "text",
          "required": true,
          "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variable_name": "<string>",
          "position": {
            "x": 50,
            "y": 50,
            "width": 50,
            "height": 50
          },
          "page_number": 2,
          "dropdown_options": [
            "<string>"
          ],
          "multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "date_default": "2023-12-25",
          "date_signing_default": true,
          "format_rules": {
            "dateFormat": "MMMM dd, yyyy"
          },
          "validation_rules": {},
          "read_only": false,
          "read_only_value": "<string>"
        }
      ],
      "created_date": "2023-11-07T05:31:56Z",
      "updated_date": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "current_page": 123,
    "page_size": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:50

Items per page

Required range: 1 <= x <= 200
name
string

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

created_after
string<date-time>

Filter templates created after this date (ISO 8601 format)

created_before
string<date-time>

Filter templates created before this date (ISO 8601 format)

sort_by
enum<string>
default:created_on

Field to sort by

Available options:
name,
created_on,
last_changed_on
sort_order
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Templates retrieved successfully

results
object[]
pagination
object