Get all templates

get https://api.cm.com/sign/v1/templates

Retrieve a paginated response of all templates.

Query Params

page

integer | null

Defaults to 1

The page of paginated templates to fetch. If not provided, gets the first page.

sortBy

string | null

Defaults to lastUsedAt

The template field to sort the templates by, order depends on the 'order' parameter.

lastUsedAt - The date the template was last used at.
name - The name of the template.

order

string | null

Defaults to asc

The order to sort the templates by, depending on the 'sortBy' parameter.

asc - Ascending. From A to Z of the name, or least recently used to most recently used.
desc - Descending. From Z to A of the name, or most recently used to least recently used.

perPage

integer | null

Defaults to 10

Number of templates to show in the response. If not provided, below 1, or above 100, will be set to 10.

string | null

Filter the templates if their name contains the search text.

Responses

Response body

object

total

integer

Total number of templates retrieved.

perPage

integer

Maximum number of templates to be shown in the data field. Can be set in the query parameter.

currentPage

integer

The current page of templates being returned.

lastPage

integer

The number of the last page containing templates.

from

integer

The index of the first template in the current page.

integer

The index of the last template in the current page.

data

array of objects

The template objects with their data. Quantity returned depends on the 'perPage' parameter.

data

object

uuid

Unique ID of the template.

name

string

Name of the template.

files

array of objects

Files linked to the template.

files

object

uuid

A unique reference number for this file.

name

string

Original name of the file without extension.

attachments

array of objects

Attachments linked to the template.

attachments

object

uuid

A unique reference number for this file.

name

string

Original name of the attachment without extension.

fields

array of objects

Fields that will be linked to the file and invitee when applying to a dossier.

fields

object

type

string

The type of field for the invitee.

signature signatureDate initials text textarea label checkbox radio stamp

required

boolean

Boolean for if the field is required to be filled by the invitee.

value

string

The value of the field, if the type is 'label'.

file

integer

The index of the file when creating the dossier to link this field to, starting from 0.

invitee

integer

The index of the invitee when creating the dossier to link this field to, starting from 0.

locations

array of objects

locations

object

range

string

length ≤ 64

The page number within the PDF that this field occupies (e.g. 1), or range for a initials field (e.g. 1-3).

float

X position of the field in points.

float

Y position of the field in points.

width

float

Width of the field in points.

height

float

Height of the field in points.

lastUsedAt

date-time

The date the template was last applied on a dossier, in ISO 8601 format.

updatedAt

date-time

The date the template was last updated, in ISO 8601 format.

createdAt

date-time

The date the template was created, in ISO 8601 format.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.cm.com/sign/v1/templates?page=1&sortBy=lastUsedAt&order=asc&perPage=10' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Templates have been retrieved.

401Unauthorized

404The specified resource was not found