Get Template
Retrieves detailed information about a specific DocuSign template including structure, roles, documents, and field definitions.
Overview
- Purpose: Get complete template details including roles, documents, and field configurations.
- Use Cases: Understanding template structure before creating envelopes, discovering field labels for pre-filling, template documentation.
- API Method: GET /templates/:templateId
Required Input Fields
Template ID: The unique identifier of the template to retrieve. Get this from ‘List Templates’ action.
Output
- Template ID: The template’s unique identifier.
- Name: Template name.
- Description: Template description.
- Email Subject: Default email subject for envelopes created from this template.
- Documents: Array of documents included in the template with their IDs and names.
- Recipients: Object containing role definitions and their associated tabs/fields.
Recipients and Roles Information
- Role Name: The generic role identifier (e.g., ‘Signer’, ‘Client’, ‘Manager’).
- Routing Order: The order in which this role receives the document.
- Tabs: Complete field definitions including text fields, signature fields, checkboxes, etc.
- Tab Labels: Field identifiers used when pre-filling values in ‘Create Envelope from Template’.
Tab Information
- Tab Types: Includes textTabs, signHereTabs, dateSignedTabs, checkboxTabs, numberTabs, emailTabs.
- Tab Label: The unique identifier for each field - use this when pre-filling values.
- Position: Page number and coordinates where the field appears.
- Required: Whether the field must be completed.
- Value: Default or pre-filled value for the field.
Tips
[!TIP] Use this action to discover field labels before creating envelopes
[!TIP] Review role names to ensure correct mapping when creating envelopes
[!TIP] Check routing order to understand the signing workflow
[!TIP] Tab labels are case-sensitive when pre-filling values
[!TIP] Cache template details to avoid repeated API calls
[!TIP] Use the tabs information to build dynamic forms in your UI
Need help? Have feedback?