### Pagination Parameters Examples Source: https://developers.pandadoc.com/reference/create-contact Example values for limit and offset query parameters. ```json 100 ``` ```json 0 ``` -------------------------------- ### Document Variables Example Source: https://developers.pandadoc.com/reference/handlecontentlibraryitemcreationfailed Example of token name and value pairs. ```json "name": "Document.GrandTotal" "value": "$29.99" ``` -------------------------------- ### Image URLs Example Source: https://developers.pandadoc.com/reference/create-document Example of a list of image URLs for replacement. ```json [ "https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png" ] ``` -------------------------------- ### Document Settings Example Source: https://developers.pandadoc.com/reference/change-signer Example JSON structure for document settings response. ```json {"language":"en-US","qualified_electronic_signature":true,"expires_in":30,"suggest_edits":false} ``` -------------------------------- ### List Users API Example Source: https://developers.pandadoc.com/reference/create-document-from-pdf Example response for listing users in an organization. ```json {"total":1,"results":[{"user_id":"ajnN7eGutJZsRKjQrNuPkh","email":"josh@example.com","first_name":"Josh","last_name":"Doe","phone_number":"+14842634627","license":"Full","is_organization_owner":true,"workspaces":[{"role":"Admin","workspace_id":"fERpqZdFaF9dHVAeVxPFaV","membership_id":"nPh2PDhFdDqAES9k64h9qX"}]}]} ``` -------------------------------- ### cURL Authentication Example Source: https://developers.pandadoc.com/reference/api-key-authentication-process Example of how to include the API key in a cURL request. ```bash curl -X GET https://api.pandadoc.com/public/v1/documents/ \ -H "Authorization: API-Key YOUR_API_KEY" ``` -------------------------------- ### Document move to folder parameter examples Source: https://developers.pandadoc.com/reference/document-details Example values for document and folder ID path parameters. ```text ZPeAfcpzr9aiVs5vqUf6jg ``` -------------------------------- ### Get Document Summary Example Source: https://developers.pandadoc.com/reference/change-signer Example JSON response for a detailed document summary request. ```json { "type": "detailed", "summary": "This agreement establishes a partnership between Party A and Party B, covering terms of service, payment schedules, intellectual property rights, and termination clauses. The contract is effective from March 2026 and runs for 12 months with automatic renewal." } ``` -------------------------------- ### Product Catalog Pricing Configuration Examples Source: https://developers.pandadoc.com/reference/create-catalog-item Examples of pricing configurations including tiered and flat pricing. ```json "example-1": { "currency": "USD", "price": null, "cost": null, "tiers": [ { "value": 9.99, "min_qty": 1 }, { "value": 8.99, "min_qty": 10 }, { "value": 5.99, "min_qty": 100 } ], "pricing_method": 1 }, "example-2": { "currency": "USD", "price": 59.99, "cost": 60, "tiers": null, "pricing_method": 0 } ``` -------------------------------- ### Get User Details Response Example Source: https://developers.pandadoc.com/reference/create-document-from-pdf Example response for retrieving details of a specific user by ID. ```json {"user_id":"ajnN7eGutJZsRKjQrNuPkh","email":"josh@example.com","first_name":"Josh","last_name":"Doe","phone_number":"+14842634627","license":"Full","is_organization_owner":true,"workspaces":[{"role":"Admin","workspace_id":"fERpqZdFaF9dHVAeVxPFaV","membership_id":"nPh2PDhFdDqAES9k64h9qX"}]} ``` -------------------------------- ### List Documents API Request Source: https://developers.pandadoc.com/docs/list-search-documents-api Example of how to list documents using a GET request. ```http GET /public/v1/documents/ HTTP/1.1 Host: api.pandadoc.com Authorization: API-Key YOUR_API_KEY ``` -------------------------------- ### Image and Text Block Configuration Examples Source: https://developers.pandadoc.com/reference/create-contact Examples showing the structure for passing image URLs and rich text content to document blocks. ```json {"urls":["https://s3.amazonaws.com/pd-static-content/public-docs/pandadoc-panda-bear.png"],"name":"Image 1"} ``` ```json {"name":"Legal Terms Section","data":"The text content to be inserted into the block."} ``` -------------------------------- ### Get Webhook Subscription Details Source: https://developers.pandadoc.com/reference/document-status Example request parameter and response for retrieving specific webhook subscription details. ```json "4fb6506c-02a0-427e-b445-b9e9ff0c822f" ``` ```json {"uuid":"4fb6506c-02a0-427e-b445-b9e9ff0c822f","name":"PandaDoc","url":"https://pandadoc.com/webhooks","status":"ACTIVE","active":true,"payload":["fields","pricing","tokens","metadata","products"],"triggers":["document_state_changed","recipient_completed","document_updated","document_creation_failed","document_deleted"],"shared_key":"GCQsdCMoVCcmXZo8yHiNGA","workspace_id":"fQ2pg3hcWgiPpa3JvfBhn2"} ``` -------------------------------- ### Create Workspace Source: https://developers.pandadoc.com/reference/document-details Request and response examples for creating a new workspace, optionally with an icon. ```json { "name": "A new workspace" } ``` ```json { "name": "A new workspace", "icon_url": "https://cdn.example.com/icons/workspace.png" } ``` ```json { "id": "5RdKYSewV5vMtik3CmoDMR", "name": "A new workspace" } ``` -------------------------------- ### OAuth 2.0 Token Management Examples Source: https://developers.pandadoc.com/reference/document-status Examples for creating an initial access token and refreshing an existing one using the OAuth 2.0 flow. ```json {"grant_type":"authorization_code","client_id":"8f0a1b2c3d4e5f6g7h8i9j","client_secret":"k1l2m3n4o5p6q7r8s9t0u","code":"v9w8x7y6z5a4b3c2d1e0f","scope":"read+write"} ``` ```json {"grant_type":"refresh_token","client_id":"89b2d1ea5f7c3b0a19456","client_secret":"e7c390f1ba8d2a6b57910c4d3b2a1e0f9d8c7b6a","refresh_token":"9a4b5c6d7e8f0g1h2i3j4k5l6m7n8o9p0q1r2s3t","scope":"read+write"} ``` -------------------------------- ### Get Member Token Error Response Example Source: https://developers.pandadoc.com/reference/get-member-token Displays the JSON structure for validation errors returned by the API. ```json { "example": { "count": [ "A valid integer is required." ], "order_by": [ "value is not a valid choice." ] } } ``` -------------------------------- ### Token and Tag Examples Source: https://developers.pandadoc.com/reference/create-document-section Examples of how to structure tokens and tags within a document creation request. ```json "name": { "type": "string", "example": "Favorite.Pet" }, "value": { "type": "string", "example": "Panda" } ``` ```json "example": [ "created_via_api", "test_document", "created_from_source" ] ``` -------------------------------- ### OpenAPI Definition for List Webhook Subscriptions Source: https://developers.pandadoc.com/reference/list-webhooks-subscriptions This snippet defines the OpenAPI structure for the GET /public/v1/webhook-subscriptions endpoint, including the response schema and example data. ```json { "openapi": "3.0.3", "info": { "title": "PandaDoc Public API", "description": "PandaDoc API spans a broad range of functionality to help you build incredible documents automation experiences inside your product.\n\nPandaDoc API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.\n\n## Getting started\n\nYou can start testing PandaDoc API with a sandbox key on our [Enterprise](https://www.pandadoc.com/pricing/) plan, either active or in trial.\n\nGenerate your [sandbox key](https://developers.pandadoc.com/reference/sandbox-key) on the Developer Dashboard with predefined [rate limits](https://developers.pandadoc.com/reference/limits). Or contact our solutions expert if you work with high-transaction volumes.\n\n## Guides\n\nIf you're just getting started with PandaDoc, you may want to jump straight into one of our [getting started guides](https://developers.pandadoc.com/docs/getting-started) for the feature you're most interested in, whether that's:\n\n- [Create from template](https://developers.pandadoc.com/docs/create-send-document),\n- [Upload and send a local PDF](https://developers.pandadoc.com/docs/upload-and-send-a-local-pdf),\n- or [Listening for changes in document status](https://developers.pandadoc.com/docs/listen-document-status-changes).\n\nWe also recommend you to discover our dynamic content generation on a fly: [Create from a template with content placeholder](https://developers.pandadoc.com/docs/create-with-content-placeholders-from-template).\n", "termsOfService": "https://www.pandadoc.com/master-services-agreement/", "contact": { "name": "PandaDoc API Support", "url": "https://developers.pandadoc.com/", "email": "api-track@pandadoc.com" }, "license": { "name": "MIT", "url": "https://github.com/PandaDoc/pandadoc-openapi-specification/blob/main/LICENSE" }, "version": "8.7.1" }, "servers": [ { "url": "https://api.pandadoc.com", "description": "Public API" } ], "security": [ { "apiKey": [] }, { "oauth2": [] } ], "tags": [ { "name": "Webhook subscriptions", "description": "Operations for managing webhook subscriptions, including listing, retrieving details, and updating shared keys." } ], "paths": { "/public/v1/webhook-subscriptions": { "get": { "tags": [ "Webhook subscriptions" ], "summary": "List Webhook Subscriptions", "description": "This operation fetches a paginated list of webhook subscriptions.", "operationId": "listWebhookSubscriptions", "responses": { "200": { "description": "List webhook subscriptions", "content": { "application/json": { "examples": { "List Webhook Subscriptions": { "value": { "items": [ { "uuid": "65fc1ec8-fb9c-4986-9d95-e2cf07e504bc", "name": "PandaDoc", "url": "https://pandadoc.com/webhooks", "status": "ACTIVE", "active": true, "payload": [ "pricing", "metadata", "tokens", "products", "fields" ], "triggers": [ "document_deleted", "document_updated", "document_state_changed", "recipient_completed", "document_creation_failed" ], "shared_key": "fhLyGE8umJ2MHuDUsJoPLG", "workspace_id": "nzJyEf2JCG2od4DUYSIpDe" } ] } } }, "schema": { "$ref": "#/components/schemas/WebhookSubscriptionListResponse" } } } }, "401": { "$ref": "#/components/responses/401" }, "429": { "$ref": "#/components/responses/429" } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "The `Authorization` header must contain the API key. The value should be prefixed with `API-Key` followed by a space and the actual API key.\n" ``` -------------------------------- ### GET /public/beta/documents/{document_id}/ai-metadata Source: https://developers.pandadoc.com/reference/create-contact Retrieves AI metadata fields populated for a document. The endpoint provides status codes to indicate if extraction is pending, failed, or not started. ```APIDOC ## GET /public/beta/documents/{document_id}/ai-metadata ### Description Returns the AI metadata fields populated for the document. Each result combines the field definition with the extracted value. ### Method GET ### Endpoint /public/beta/documents/{document_id}/ai-metadata ### Parameters #### Path Parameters - **document_id** (string) - Required - The unique identifier of the document. #### Query Parameters - **limit** (integer) - Optional - Maximum number of fields to return in one response (default: 100). - **offset** (integer) - Optional - Number of fields to skip before starting to collect the result set (default: 0). ### Response #### Success Response (200) - **count** (integer) - Total number of results. - **results** (array) - List of extracted AI metadata fields. #### Response Example { "count": 2, "results": [ { "id": "3SBkwkGBbMn6btzHTiKkGn", "key": "Counterparty name", "field_type": "multi_line", "settings": {}, "value": { "id": "5KqRz9WLPzm4jx2hTb3vGz", "value": "Acme Corp", "source": "model", "acceptance_status": "pending" } } ] } ``` -------------------------------- ### FullStory Setup Source: https://developers.pandadoc.com/reference/api-key-authentication-process Initializes the FullStory session recording script. ```javascript ``` -------------------------------- ### Document Event Example Source: https://developers.pandadoc.com/reference/pdfofcompleteddocumentavailablefordownload Example JSON payload for a document_updated event. ```json "example": [ { "event": "document_updated", "data": { "id": "tGRhZTANFmeKKqoyvs4zzX", "name": "Marketing Proposal - Updated", "status": "document.draft", "date_created": "2025-06-13T15:59:46.798660Z", "date_modified": "2025-06-16T11:57:46.616589Z", "date_completed": null, "date_sent": null, "expiration_date": "2025-08-15T11:57:35.146922Z", "autonumbering_sequence_name": null, "created_by": { "id": "FA5QAu8UGA3oVDQZuPL75B", "email": "fname.lname@pandadoc.com", "first_name": "FName", "last_name": "LName", "avatar": null, "membership_id": "TcZLMBcF7gvMxAZGn8SofS" }, "template": { "id": "gZRVmyHiQV5riXSCMKsku2", "name": "Sample Template" }, "version": "3", "grand_total": { "amount": "1250.00", "currency": "EUR" }, "recipients": [ { "id": "bLvGfL77Yd2mqoHvdjhn59", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone": "+1-555-0123", "recipient_type": "signer", "role": "Client", "roles": [ "Client" ], "has_completed": false, "signing_order": 1, "contact_id": "gEgusViKyvWn5UTh8yRBkT", "shared_link": "", "signature_date": null, "type": "recipient" } ], "sent_by": null, "tags": [ "updated", "marketing", "proposal" ], "linked_objects": [], "metadata": { "document__updated_via_public_api": "true", "project_id": "PROJ-2024-001" }, "tokens": [ { ``` -------------------------------- ### List Templates Query Parameters Examples Source: https://developers.pandadoc.com/reference/change-signer Example values for various query parameters used when listing templates. ```json "Sample onboarding template" ``` ```json false ``` ```json 10 ``` ```json 1 ``` ```json "e9LxBesSL73AeZMzeYdfvV" ``` ```json "xDKHoJ8DkwhiTQSUzNveCJ" ``` -------------------------------- ### Document Identifier Example Source: https://developers.pandadoc.com/reference/handlecontentlibraryitemcreationfailed Example of the 22-character alphanumeric document ID. ```json "tGRhZTANFmeKKqoyvs4zzX" ``` -------------------------------- ### FullStory Setup Source: https://developers.pandadoc.com/reference/authentication-process Configures the FullStory recording environment and namespace. ```javascript window['_fs_host'] = 'fullstory.com'; window['_fs_script'] = 'edge.fullstory.com/s/fs.js'; window['_fs_org'] = '8SYR6'; window['_fs_namespace'] = 'FS'; !function(m,n,e,t,l,o,g,y){var s,f,a=function(h){ return!(h in m)||(m.console&&m.console.log&&m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].'),!1)}(e) ;function j(b){var h,d=[];function k(){h&&(d.forEach((function(b){var d;try{d=b[h[0]]&&b[h[0]](h[1])}catch(h){return void(b[3]&&b[3](h))} d&&d.then?d.then(b[2],b[3]):b[2]&&b[2](d)})),d.length=0)}function r(b){return function(d){h||(h=[b,d],k())}}return b(r(0),r(1)),{ then:function(b,h){return j((function(r,i){d.push([b,h,r,i]),k()}))}}}a&&(g=m[e]=function(){var b=function(b,d,k,r){function i(i,c){ h(b,d,k,i,c,r)}r=r||2;var c,u=/Async$/;return u.test(b)?(b=b.replace(u,""),"function"==typeof ``` -------------------------------- ### DocumentMetadata Example Source: https://developers.pandadoc.com/reference/handlecontentlibraryitemcreated Example of custom metadata fields that can be associated with a document. ```json { "document__created_via_public_api": "true", "document__creation_source": "public api", "my_favorite_pet": "Panda" } ``` -------------------------------- ### Create User Response Example Source: https://developers.pandadoc.com/reference/create-user Example JSON response structure returned after successfully creating a user. ```json "workspaces": [ { "workspace_id": "MwZbjUVD5C3srSSxkpF4Aj", "role": "Member", "member_id": "VQDH2hdAPJBhSWmMrYa3zu" } ], "user_id": "KwahvjapLm4RDf6pfyYdjA" } } } } } }, ``` -------------------------------- ### Document Creation Response Example Source: https://developers.pandadoc.com/reference/create-document Example response returned after successfully initiating a document creation request. ```json { "id": "D3okRfgHRX7NEhavcACReB", "name": "Document from Template", "status": "document.uploaded", "date_created": "2024-07-04T19:27:14.927317Z", "date_modified": "2024-07-04T19:27:14.927317Z", "expiration_date": null, "version": null, "uuid": "D3okRfgHRX7NEhavcACReB", "links": [ { "rel": "status", "href": "https://api.pandadoc.com/public/v1/documents/D3okRfgHRX7NEhavcACReB", "type": "GET" } ], "info_message": "You need to poll the Document Status method until the status will be changed to document.draft" } ```