Templates

Get a template

get/templates/{id}

Returns the roles you must fill and the prefilled fields you can set when you send this template.

Needs a key with templates:read.

Path parameters

idUUIDRequired
The template ID.

Example request

curl "https://www.inkly.so/api/v1/templates/a2d94c10-6e7b-4f38-8c15-1f3e9b7d6c02" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Example response, 200

{
  "template": {
    "id": "a2d94c10-6e7b-4f38-8c15-1f3e9b7d6c02",
    "title": "Consulting agreement",
    "created_at": "2026-11-02T15:04:05.123Z",
    "signing_order": "parallel",
    "roles": [
      {
        "role_id": "c81e7f42-0b39-4d6a-a7c4-92e15d3f8b76",
        "label": "Client",
        "role": "signer",
        "in_person": false,
        "file_requests": []
      }
    ],
    "prefilled_fields": [
      {
        "label": "Project name",
        "key": "project_name",
        "required": true,
        "type": "text"
      }
    ]
  }
}

Response fields

templateobjectRequired
6 child fields
- idUUIDRequired
- titlestringRequired
- created_attimestampRequired
- signing_orderstringRequired
  One of parallel, sequential
- rolesarray of objectsRequired
  5 child fields
  - role_idUUIDRequired
    Use this in recipients[].role_id when you send.
  - labelstringRequired
  - rolestringRequired
    One of signer, cc
  - in_personbooleanRequired
    Templates with in-person signers cannot be sent through the API.
  - file_requestsarray of objectsRequired
    Files this signer is asked to upload.
    3 child fields
    namestringRequired
    requiredbooleanRequired
    positionnumberRequired
- prefilled_fieldsarray of objectsRequired
  Fields you fill in when you send, through prefilled_values.
  4 child fields
  - labelstringRequired
  - keystringRequired
    The normalized label.
  - requiredbooleanRequired
  - typestringRequired

Errors specific to this endpoint

template_not_found404Template not found.

Every endpoint can also return the common errors.