Fetch an e-sign template

GET

/esign/templates/{template_id}/

Fetch one agency e-sign template available to the API key user. The response includes template metadata and recipient roles only; template files and field coordinates stay private to the dashboard/editor flow. Use the returned recipient_roles[].id values as template_role_id values when creating a document from this template.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

Template metadata and recipient roles.

Bodyapplication/json

🟠403Forbidden

🟠404NotFound

🔴500UnknownError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/esign/templates//' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "email_subject": "string",
    "email_message": "string",
    "completion_message": "string",
    "resolved_email_subject": "string",
    "resolved_email_message": "string",
    "resolved_completion_message": "string",
    "cc_emails": [
        "user@example.com"
    ],
    "recipient_roles": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "role_name": "string",
            "order": 1,
            "require_2fa": true,
            "two_fa_method": "sms",
            "verification_type": "quick_id"
        }
    ],
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "expiry_days": 1,
    "expiry_alert_days": 1,
    "first_reminder_days": 1,
    "second_reminder_days": 1
}

List e-sign templates

List e-sign documents