templates

Retrieve template details

Retrieves detailed information about a specific template, including its fields, signees, and metadata.

Notes:

  • Templates contain pre-configured signature fields and signee details.
  • You can use this endpoint to review the template's details before creating a document using the template.
get/templates/{templateId}

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/templates/{templateId}
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Path parameters

templateIdstring uuid required

The unique identifier of the template.

Response

Template details retrieved successfully

templateIdstring uuid

Unique identifier of the template

namestring

Name of the template

createdAtstring date-time

Timestamp when the template was created

userIdstring uuid

User ID of the document owner

sharingSetting'shared' | 'private'

Sharing setting for the template

Example response

{
  "signeeDetails": [
    {
      "fullName": "Jane Smith",
      "emailAddress": "jane.smith@example.com",
      "phoneNumber": null,
      "signatureType": "digital_ink",
      "signaturePlacement": "existing",
      "signatureBox": {
        "page": 0,
        "x": 72,
        "y": 560,
        "scale": 1
      },
      "idScanBox": null,
      "signingOrder": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.