This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Get template

GET

https://api.signater.com/v1/ecm/templates/{templateId}

Template

Last modified:2025-03-29 12:47:42

Retrieves a template by its unique identifier. This endpoint allows you to access the template's content and fields configuration.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

templateId

string <uuid>

required

Template ID

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Template retrieved successfully

Body

string <uuid>

optional

Id of the vault

vaultId

string <uuid>

optional

Id of the vault

vaultName

string | null

optional

Name of the vault

name

string | null

optional

Name of the template

description

string | null

optional

Description of the template

payload

string | null

optional

Payload of the template

fields

array[object (GetTemplateFieldApiResponse) {7}] | null

optional

Fields of the template

string <uuid>

optional

Id of the field

name

string | null

optional

Name of the field

alias

string | null

optional

Alias of the field

isRequired

boolean

optional

Indicates if the field is required

type

enum<string>

optional

Type of the field

Allowed values:

BrCepBrCpfBrCnpjDateOnlyTimeOnlyDateTimeEmailNumberTextCustom

customRegex

string | null

optional

Custom regex when Type is Custom

index

integer <int32>

optional

Index of the field, starting from 0

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "vaultId": "867f3a98-ec66-42f4-abbc-5980239e4a28",
  "vaultName": "string",
  "name": "string",
  "description": "string",
  "payload": "string",
  "fields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "alias": "string",
      "isRequired": true,
      "type": "BrCep",
      "customRegex": "string",
      "index": 0
    }
  ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-03-29 12:47:42

Create signature link

Update template