Pigeon // E-Sign
  1. Templates
Pigeon // E-Sign
  • Introduction
  • Authentication
  • Integrations
  • Documents
    • List Documents
      GET
    • Create Document
      POST
    • Get Document Status
      GET
    • Delete Document
      DELETE
    • Update Document
      PATCH
    • Update Document Status
      PATCH
    • Move Document to Draft
      POST
    • Get Document Details
      GET
    • Send Document
      POST
    • Create Document Session
      POST
    • Download Document
      GET
    • Download Protected Document
      GET
    • Update Document Ownership
      PATCH
    • Transfer Documents Ownership
      PATCH
  • Document Attachments
    • Document Attachment List
      GET
    • Document Attachment Create
      POST
    • Document Attachment Details
      GET
    • Document Attachment Delete
      DELETE
    • Document Attachment Download
      GET
  • Document Generation
    • List Document Fields
      GET
    • Create Document Fields
      POST
  • Document Recipients
    • Add Document Recipient
    • Edit Document Recipient
    • Delete Document Recipient
    • Reassign Document Recipient
  • Bulk Send
    • Trigger Bulk Send
    • Create Bulk Send List
    • Get Bulk Send List
    • Get Bulk Send Lists
    • Update Bulk Send List
    • Delete Bulk Send List
  • Templates
    • List Templates
      GET
    • Create Template
      POST
    • Template Details
      GET
    • Delete Template
      DELETE
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Webhooks
    • Get all webhook subscriptions
    • Create webhook subscription
    • Get webhook subscription by uuid
    • Update webhook subscription
    • Delete webhook subscription
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  1. Templates

Template Details

GET
/templates/{id}/details
Get details about a template by id. Details include:
Basic template information (name, author, etc)
Roles
All fields with values
All tokens with values
Template metadata
Template tags
Content placeholders
Modification timestamps. Note that date_modified means any changes associated with the template roles, while content_date_modified logs any changes in the template content.

Request

Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/templates/vibuun3DXG8QDDLfXm27Ne/details'

Responses

🟢200OK
application/json
OK
Body

Example
{
    "id": "vibuun3DXG8QDDLfXm27Ne",
    "name": "New template",
    "date_created": "2024-07-15T17:44:07.524Z",
    "date_modified": "2024-07-15T17:44:07.613Z",
    "content_date_modified": "2024-07-15T17:44:08.685Z",
    "created_by": {
        "id": "FA5QAu8UGA3oVDQZuPL75B",
        "email": "siarhei.soroka@pigeondocuments.com",
        "first_name": "Siarhei",
        "last_name": "Soroka",
        "avatar": null,
        "membership_id": "RyMNXBjBPRppw56TfYBrXi"
    },
    "metadata": {},
    "tokens": [],
    "fields": [],
    "pricing": {},
    "tags": [],
    "roles": [
        {
            "id": "UDhBsFhy4857fsdBJ11FuL",
            "name": "Client",
            "signing_order": null,
            "preassigned_person": null
        }
    ],
    "version": "2",
    "content_placeholders": [],
    "images": []
}
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠429429
Modified at 2024-09-18 01:34:08
Previous
Create Template
Next
Delete Template