Get a template

get https://api.dottedsign.com/v1/templates

Get a template.

scope: templates.general.read
available user plans: pro, business, and enterprise

Responses

Response body

object

data

object

Template (full version).

template_id

integer

Template ID.

file_name

string

Template name.

has_order

boolean

Signers should sign sequentially or not.

status

string

Template status.

active deleted

access_info

object

Template access info.

details

array of objects

Stage details.

details

object

stage_id

integer

Stage ID.

role

string

Signer's role.

string

Actor's email.

stage_type

string

Stage type.

sign edit form_sign

sequence

integer

Stage sequence, which starts from 1.

status

string

Stage status.

initial processing signed done modifying reviewed declined canceled

stage_setting

object

Stage setting.

custom_message_setting

object

Stage custom message setting.

attachment_settings

array of objects

attachment_settings

object

attachment_id

string

Attachment ID.

file_name

string

Attachment name.

force

boolean

Signer must upload attachment or not.

viewable_in_processing

boolean

Attachment is viewable by other signers or not, will be effective along with viewable_in_processing in StageSetting.

field_settings

array of objects

field_settings

object

field_type

string

Field type.

signature textfield datefield checkbox radio

field_value

Field value.

field_value_type

string | null

Field value type.

signature guest_signature seal

field_object_id

string

Field object ID.

field_group_object_id

string | null

Field group object ID.
Used for checkbox and radio.

page

integer

Page number. Starts from 0.

coord

array of integers

Field coordinates, consisting of 4 numbers. These numbers represent the left-x, bottom-y, right-x, and top-y coordinates, respectively.

coord

options

object

Field options.

field_setting_groups

array of objects

field_setting_groups

object

field_group_type

string

Field group type.

checkbox radio

field_group_object_id

string

Field group object ID.

options

object

review_stages

array of objects

review_stages

object

review_stage_id

integer

Review stage ID.

stage_id

integer | null

Stage ID.

stage_type

string | null

Stage type.

SignStage DummyStage

base_stage_id

integer | null

Signer's stage ID.

base_stage_type

string | null

Signer's stage type.

SignStage DummyStage

sequence

integer

Review sequence.

status

string

Review status.

initial reviewing reviewed

name

string

Reviewer's name.

string

Reviewer's email.

reviewed_by_owner

boolean

Reviewed by owner or not.

verify_methods

array of objects

verify_methods

object

uuid

string

UUID.

sequence

integer

Verify sequence.

verify_type

string

verify type.

email sms

verify_source

string

verify source.

occasion

string

verify occasion.

sign read

template_setting

object

Template setting.

metadata

object

Metadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

Has additional fields

created_at

integer

Template creation timestamp.

last_modified_at

integer

Template last modification timestamp.

download_link

object

Template download link.

file_mission_info

object

File mission info.

share_setting

object

Template share setting.

thumbnail

object

Template thumbnail.

watermark_info

object

Watermark info.

Headers

object

Content-Type

string

Content-Length

integer

200200

400400

403403

404404