Get Template

GET 
/template/:template_id

The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.

Request

Path Parameters

template_id strngrequired

ID of template that needs to be fetched

Responses

200

successful operation

application/json

Schema

Schema

objectId string
title string
note string

folder

object

objectId string

name string
file string
owner string

signers

object[]

Array [

role string

name string

email string

phone string

widgets

object[]

Array [

type string

Allowed values - signature, stamp.

x number

y number

w number

h number

page number

]

]

sendInOrder boolean
createdAt date
updatedAt date
enableTour boolean
redirect_url string
allow_modifications boolean

Example (from schema)

{
  "objectId": "x1Hbnms2Pg",
  "title": "sample template",
  "note": "template note",
  "folder": {
    "objectId": "x1Hbnms2Pg",
    "name": "folder name"
  },
  "file": "https://templateuser.com",
  "owner": "template creator name",
  "signers": [
    {
      "role": "ceo",
      "name": "joe bee",
      "email": "joebee@example.com",
      "phone": "456213871",
      "widgets": [
        {
          "type": "signature",
          "x": 244,
          "y": 71,
          "w": 38,
          "h": 46,
          "page": 1
        }
      ]
    }
  ],
  "sendInOrder": true,
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z",
  "enableTour": true,
  "redirect_url": "",
  "allow_modifications": false
}

400

Something went wrong, please try again later!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Something went wrong, please try again later!"
}

404

Template not found!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Template not found!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...