Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB
Documents

Document 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
  • Pricing information (pricing tables, products, quotes, etc.)
  • Content block names for table, image, and text blocks (tables, images, texts)
  • Metadata
  • Tags
  • Linked objects
  • Approval flow (if present)
  • Active editing lock (holder and expiry), when the document is locked
  • 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.
get/public/v1/documents/{id}/details

Path parameters

idstring required

Document ID

Response

OK

idstring

Document ID.

namestring

Document name.

{"stackTrail":"components:schemas:DocumentDetailsResponse:properties:autonumbering_sequence_name_prefix","oasType":"schema","type":"unknown"}
folder_uuidstring nullable

ID of the folder where the created document should be stored.

date_createdstring

Document creation date.

date_modifiedstring

Document modification date.

date_completedstring nullable

Document completion date.

content_date_modifiedstring

Document content modification date.

date_sentstring nullable

Document sent date.

ref_numberstring

Document reference number.

expiration_datestring nullable

Document expiration date.

metadataobject

Document metadata.

tagsstring[]

Document tags.

status'document.draft' | 'document.sent' | 'document.completed' | 'document.uploaded' | 'document.error' | 'document.viewed' | 'document.waiting_approval' | 'document.approved' | 'document.rejected' | 'document.waiting_pay' | 'document.paid' | 'document.voided' | 'document.declined' | 'document.external_review' | 'document.scheduled'
versionstring

Document version.

Example response

{
  "id": "7kqXgjFejB2toXxjcC5jfZ",
  "name": "API Sample Document from PandaDoc Template",
  "folder_uuid": "QMDSzwabfFzTgjW4kUijqQ",
  "date_created": "2021-10-23T21:07:04.147345Z",
  "date_modified": "2021-10-23T21:07:04.147345Z",
  "date_completed": "2021-10-23T21:07:04.147345Z",
  "content_date_modified": "2021-10-23T21:07:04.147345Z",
  "date_sent": "2021-10-23T21:07:04.147345Z",
  "ref_number": "MTMJR-FEUQB-ECEWW-3WVZP",
  "created_by": {
    "id": "7kqXgjFejB2toXxjcC5jfZ",
    "membership_id": "7kqXgjFejB2toXxjcC5jfZ",
    "email": "teset@test.test",
    "first_name": "Jhon",
    "last_name": "Dow",
    "avatar": "https://pd-live-media.s3.amazonaws.com/users/000GTSGwJw000L2KZqc000/avatar.jpg"
  },
  "template": {
    "id": "hryJY9mqYZHjQCYQuSjRQg",
    "name": "Upload test"
  },
  "expiration_date": "2021-10-23T21:07:04.147345Z",
  "metadata": {
    "document__created_via_public_api": "true",
    "my_favorite_pet": "Panda",
    "opp_id": "1234567"
  },
  "tokens": [
    {
      "name": "Document.GrandTotal",
      "value": "$29.99"
    },
    {
      "name": "Favorite.Pet",
      "value": "Panda"
    }
  ],
  "fields": [
    {
      "uuid": "f9574c3b-5b1e-4479-b2c9-c3ccd92748f3",
      "name": "Click to upload a file",
      "title": "",
      "placeholder": "Click to upload a file",
      "value": {
        "name": "file_name.pdf",
        "url": "https://uploadfields.pandadoc-static.com/collect_files/e7b082c2-395b-43c7-a24c-66bd1bbb5d2f/65af1f23-9d26-4622-8ff0-f406b3be27b8-file_name.pdf"
      },
      "assigned_to": {
        "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
        "first_name": "John",
        "last_name": "Roe",
        "email": "john@example.com",
        "recipient_type": "signer",
        "has_completed": false,
        "role": "",
        "roles": [
          "singer"
        ],
        "type": "recipient"
      },
      "field_id": "CollectFile1",
      "type": "collect_file",
      "is_filled": true
    },
    {
      "uuid": "f9574c3b-5b1e-4479-b2c9-c3ccd92748f3",
      "name": "Favorite.Color",
      "merge_field": "Favorite.Color",
      "title": "Textfield",
      "value": "value",
      "assigned_to": {
        "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
        "name": "Group 2",
        "email": "group2@example.com",
        "recipient_type": "signer",
        "has_completed": false,
        "roles": [],
        "type": "recipient_group",
        "members": [
          {
            "id": "4b011d86-286b-4f86-b697-90a6ad3f1489",
            "email": "john@example.com",
            "first_name": "John",
            "last_name": "Doe"
          }
        ]
      },
      "field_id": "text1",
      "type": "text",
      "is_filled": true
    },
    {
      "uuid": "M4755SJuoyz5Jzsw4WXTDb",
      "name": "Like",
      "merge_field": "Like",
      "title": "Checkbox",
      "value": true,
      "assigned_to": {
        "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
        "first_name": "John",
        "last_name": "Roe",
        "email": "john@example.com",
        "recipient_type": "signer",
        "has_completed": false,
        "role": "",
        "roles": [
          "signer"
        ],
        "type": "recipient"
      },
      "field_id": "checkbox1",
      "type": "checkbox",
      "is_filled": true
    }
  ],
  "pricing": {
    "tables": [
      {
        "name": "Pricing Table",
        "id": "065c5cbc-a065-4843-ba17-028e63779605",
        "total": "11500",
        "summary": {
          "subtotal": "11500",
          "total": "11500",
          "discount": "0",
          "tax": "0",
          "fee": "0"
        },
        "items": [
          {
            "qty": "10",
            "name": "Annual license",
            "price": "100",
            "description": "1 year subscription",
            "custom_fields": {},
            "custom_columns": {
              "Images": "",
              "Cost": "",
              "Subtotal": ""
            },
            "subtotal": "10000",
            "options": {},
            "sale_price": "1000",
            "taxes": {},
            "discounts": {},
            "fees": {},
            "merged_data": {
              "custom_name": "SomeName",
              "custom_description": "SomeCustomDescription",
              "custom_price": "10.99",
              "custom_qty": "1.00",
              "custom_sku": "Test",
              "custom_tax": {
                "value": "10",
                "type": "percent"
              },
              "custom_fee": {
                "value": "10",
                "type": "percent"
              },
              "custom_discount": {
                "value": "10",
                "type": "percent"
              },
              "custom_text": "Some other",
              "Cost": null,
              "Subtotal": "26.38",
              "fluffiness": "Fluffiness",
              "Other_field": "SomeText"
            }
          }
        ],
        "currency": "USD"
      }
    ],
    "quotes": [
      {
        "id": "4b011d86-286b-4f86-b697-90a6ad3f1489",
        "currency": "USD",
        "total": "900",
        "summary": {
          "total": "900",
          "subtotal": "1000",
          "one_time_subtotal": "500",
          "recurring_subtotal": [
            {
              "billing_cycle": "monthly",
              "value": "500"
            }
          ],
          "total_discount": "100",
          "total_contract_value": "1900"
        },
        "sections": [
          {
            "summary": {
              "total": "1000",
              "subtotal": "1000",
              "one_time_subtotal": "500",
              "recurring_subtotal": [
                {
                  "billing_cycle": "monthly",
                  "value": "500"
                }
              ],
              "total_section_value": "1900"
            },
            "items": [
              {
                "qty": "1",
                "price": "500",
                "overall_total": "1000"
              }
            ],
            "total": "1000"
          }
        ]
      }
    ],
    "total": "11500"
  },
  "texts": [
    {
      "name": "Legal Terms Section"
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "recipients": [
    {
      "id": "7kqXgjFejB2toXxjcC5jfZ",
      "recipient_type": "signer",
      "roles": [
        "user"
      ],
      "email": "test@test.com",
      "has_completed": true,
      "last_name": "Dow",
      "contact_id": "7kqXgjFejB2toXxjcC5jfZ",
      "first_name": "Jhon",
      "phone": "+14842634627",
      "shared_link": "https://app.pandadoc.com/document/b7f11ea3c09d1c11208cc122457d4f3a2829d364",
      "signature_date": "2021-10-23T21:07:04.147345Z",
      "verification_settings": {
        "verification_place": "before_open",
        "email_otp_verification": {
          "email": "user@example.com"
        }
      },
      "redirect": {
        "url": "https://example.com"
      },
      "avatar": "https://pd-live-media.s3.amazonaws.com/users/000GTSGwJw000L2KZqc000/avatar.jpg",
      "type": "recipient"
    }
  ],
  "grand_total": {
    "amount": "29.99",
    "currency": "USD"
  },
  "linked_objects": [
    {
      "provider": "hubspot",
      "entity_type": "deal",
      "entity_id": "18640",
      "id": "ea88ed1dc8094dd3a57754aa643a1954",
      "children": [
        {
          "entity_type": "child-deal",
          "entity_id": "19640",
          "id": "ea88ed1dc8094dd3a57754aa643a1954"
        }
      ]
    }
  ],
  "status": "document.draft",
  "approval_execution": {
    "document_uuid": "1234567890",
    "revision_number": 1
  },
  "version": "1",
  "lock": {
    "locked_by_user_id": "ajnN7eGutJZsRKjQrNuPkh"
  }
}