Pigeon // E-Sign
  1. Documents
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
      POST
    • Edit Document Recipient
      PATCH
    • Delete Document Recipient
      DELETE
    • Reassign Document Recipient
      POST
  • 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
    • Create Template
    • Template Details
    • Delete Template
  • 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. Documents

Get Document Details

GET
/documents/{id}/details
Return detailed data about a document. Use Document Status for getting just a basic info and status.
Get details about a document by its id. Details include:
Basic document information (name, document state, owner, sender, grand total, etc.)
Recipients (completion status, signing order, etc.)
Fields with values (incl. Collect Files field)
Tokens (variables) with values
Metadata
Tags
Timestamps associated with a document. Note that date_modified means any changes associated with the recipients and document status, while content_date_modified reflects any changes in the document 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 '/documents/BhVzRcxH9Z2LgfPPGXFUBa/details'

Responses

🟢200OK
application/json
OK
Body

Examples
{
    "approval_execution": null,
    "content_date_modified": "2024-07-08T15:43:54.194562Z",
    "linked_objects": [],
    "date_completed": "2024-07-08T15:43:53.877522Z",
    "id": "f9CbJKS4ZAs6nU629cuowb",
    "name": "Digital Marketing Proposal",
    "autonumbering_sequence_name_prefix": null,
    "date_created": "2024-07-08T15:36:09.600947Z",
    "date_modified": "2024-07-08T15:43:53.918819Z",
    "date_sent": "2024-07-08T15:41:23.351853Z",
    "ref_number": "MTMJR-FEUQB-ECEWW-3WVZP",
    "created_by": {
        "id": "FA5QAu8UGA3oVDQZuPL75B",
        "email": "creator@pigeondocuments.com",
        "first_name": "Pigeon",
        "last_name": "Docs",
        "avatar": null,
        "membership_id": "RyMNXBjBPRppw56TfYBrXi"
    },
    "template": {
        "id": "gZRVmyHiQV5riXSCMKsku2",
        "name": "Sample Template"
    },
    "expiration_date": "2024-09-06T15:43:36.297737Z",
    "metadata": {
        "document__created_via_public_api": "true",
        "document__creation_source": "public api"
    },
    "tokens": [],
    "fields": [
        {
            "uuid": "f03e22f3-b3a8-4783-8b26-e43880ef87bf",
            "name": "Signature",
            "title": "",
            "value": {},
            "placeholder": "Signature",
            "assigned_to": {
                "id": "8KAZvGRL3W4u44a4fyDoeH",
                "first_name": "Recipient First Name",
                "last_name": "Recipient Last Name",
                "email": "test@pigeondocuments.com",
                "phone": "",
                "recipient_type": "signer",
                "has_completed": true,
                "role": "Client",
                "roles": [
                    "Client"
                ],
                "signing_order": null,
                "delivery_methods": {
                    "sms": false,
                    "email": true
                },
                "redirect": {
                    "is_enabled": false,
                    "url": null
                },
                "type": "recipient"
            },
            "field_id": "signature_f03e22f3-b3a8-4783-8b26-e43880ef87bf",
            "type": "signature"
        }
    ],
    "pricing": {},
    "tags": [
        "tag1"
    ],
    "status": "document.completed",
    "recipients": [
        {
            "id": "8KAZvGRL3W4u44a4fyDoeH",
            "first_name": "Recipient First Name",
            "last_name": "Recipient Last Name",
            "email": "test@pigeondocuments.com",
            "phone": "",
            "recipient_type": "signer",
            "has_completed": true,
            "role": "Client",
            "roles": [
                "Client"
            ],
            "signing_order": null,
            "delivery_methods": {
                "sms": false,
                "email": true
            },
            "redirect": {
                "is_enabled": false,
                "url": null
            },
            "contact_id": "HzXnuyNraSXMhXchYjUmHJ",
            "shared_link": "https://app.pigeondocuments.com/document/15d4b481384b652a298530ddc7023bfc07a67d59",
            "signature_date": "2024-07-08T15:43:53.800135Z",
            "verification_settings": null,
            "type": "recipient"
        }
    ],
    "sent_by": {
        "id": "FA5QAu8UGA3oVDQZuPL75B",
        "email": "sender@pigeondocuments.com",
        "first_name": "Pigeon",
        "last_name": "Docs",
        "avatar": null
    },
    "grand_total": {
        "amount": "0",
        "currency": "EUR"
    },
    "version": "2"
}
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409409
🟠429429
Modified at 2024-09-18 01:31:50
Previous
Move Document to Draft
Next
Send Document