Get Template

Retrieve full details of a specific template by its ID, including files, recipients, and template variables.

Endpoint

GET https://api.airsign.com.au/api/v1/Template/{templateId}

Headers

Name	Value	Required	Description
Authorization	Bearer {access_token}	Yes	Bearer token obtained from authentication

Path Parameters

Parameter	Type	Required	Description
templateId	string	Yes	The unique identifier of the template

Example Request

curl --location 'https://api.airsign.com.au/api/v1/Template/{templateId}' \
--header 'Authorization: Bearer {access_token}'

Response

Status: 200 OK

{
  "templateId": "{uuid}",
  "name": "Employment Contract",
  "status": "active",
  "selfSignOnly": false,
  "createdAt": "2025-05-01T08:00:00.000Z",
  "updatedAt": "2025-06-10T12:00:00.000Z",
  "files": [
    {
      "fileId": "{uuid}",
      "fileName": "contract.pdf"
    }
  ],
  "recipients": [
    {
      "recipientId": "default",
      "name": "Employee",
      "email": "",
      "recipientType": "toCompleteEmail",
      "signingOrder": 1
    }
  ],
  "variables": [
    {
      "variableId": "{uuid}",
      "name": "employee_name",
      "displayName": "Employee Name",
      "type": "text",
      "required": true,
      "defaultValue": "",
      "description": "Full legal name of the employee"
    }
  ]
}

Response Fields

Field	Type	Description
variables	array	Template variables that can be filled when creating a session via `variableValues`
variables[].type	string	Variable type: `text`, `number`, `date`, `image`, `table`
variables[].required	boolean	Whether a value must be provided when creating a session
recipients	array	Template recipients. Empty name/email fields should be filled when creating a session

Error Responses

Status	Description
401	Unauthorized - invalid or missing token
404	Template not found or does not belong to your organisation
429	Rate limit exceeded