PandaDoc Developers

https://developers.pandadoc.com/llms.txt
Admin
This project provides comprehensive documentation and API references for developers to integrate...
Tokens:391,219
Snippets:2,359
Trust Score:10
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Add PandaDoc MCP server to OpenCode

Source: https://developers.pandadoc.com/docs/getting-started-with-mcp

Starts the interactive setup for adding the PandaDoc MCP server in OpenCode. Follow the prompts to enter the server name, type, URL, and OAuth settings.

```bash
opencode mcp add
```

--------------------------------

### Install pandadoc-signing with yarn

Source: https://developers.pandadoc.com/docs/signing-session-embed

Install the pandadoc-signing library using the yarn package manager.

```text
yarn add pandadoc-signing
```

--------------------------------

### HTTP Authorization Header Example

Source: https://developers.pandadoc.com/reference/authentication-process

Example of an Authorization header with a sample access token.

```yaml
Authorization: Bearer 3039ba033eb1410caa0a2227158d63c9d6502cd8
```

--------------------------------

### Install pandadoc-signing with npm

Source: https://developers.pandadoc.com/docs/signing-session-embed

Install the pandadoc-signing library using the npm package manager.

```text
npm install pandadoc-signing
```

--------------------------------

### Filter by Status

Source: https://developers.pandadoc.com/docs/list-documents-api-parameters

Use these GET requests to retrieve documents by status. The first example gets all completed documents (status=2), and the second excludes draft documents (status__ne=0).

```bash
# Get all completed documents
GET /public/v1/documents?status=2
```

```bash
# Exclude draft documents
GET /public/v1/documents?status__ne=0
```

--------------------------------

### Install pandadoc-editor with npm

Source: https://developers.pandadoc.com/docs/editor-embed

Install the pandadoc-editor library using the npm package manager.

```text
npm install --save pandadoc-editor
```

--------------------------------

### Filter by Metadata

Source: https://developers.pandadoc.com/docs/list-documents-api-parameters

Use these GET requests to filter documents by metadata fields. The first example filters by a single opportunity ID, and the second combines multiple metadata fields.

```bash
# Filter by opportunity ID
GET /public/v1/documents?metadata_opportunity_id=2181432
```

```bash
# Filter by multiple metadata fields
GET /public/v1/documents?metadata_opportunity_id=2181432&metadata_custom_key=custom_value
```

--------------------------------

### Create Linked Object response example

Source: https://developers.pandadoc.com/reference/link-to-crm

Example response for a successful creation (HTTP 201). Includes the provider, entity type, entity ID, and the generated linked object ID.

```json
{
  "provider": "pipedrive",
  "entity_type": "deal",
  "entity_id": "134",
  "id": "abb4d3fc-919b-491e-9e08-775036660c0b"
}
```

--------------------------------

### Install pandadoc-editor with yarn

Source: https://developers.pandadoc.com/docs/embedded-editing-e-token

Install the PandaDoc Embedded Editor npm package using yarn.

```bash
yarn add pandadoc-editor
```

--------------------------------

### Filter Documents with List Documents API

Source: https://developers.pandadoc.com/docs/filter-search-documents

Example GET requests to the List Documents API using various filters: by template with date range, by metadata key, excluding a status, and filtering by completed status. Each request includes ordering and count parameters.

```bash
GET /public/v1/documents?template_id=ABC123&order_by=date_created&created_from=2023-08-01T00:00:00Z&created_to=2023-09-01T00:00:00Z&count=100
```

```bash
GET /public/v1/documents?metadata_opportunity_id=2181432&order_by=date_created&count=50
```

```bash
GET /public/v1/documents?status__ne=0&order_by=date_created&count=50
```

```bash
GET /public/v1/documents?status=2&order_by=date_created&count=50
```

--------------------------------

### Share with two workspaces - request body example

Source: https://developers.pandadoc.com/reference/updatetemplatesharingsettings

Example request body for sharing a template with two workspaces. The workspace_ids array contains the identifiers of the workspaces to share with.

```json
{
  "workspace_ids": [
    "BhVzRcxH9Z2LgfPPGXFUBa",
    "2eWSKSvVqmuVCnuUK3iWwD"
  ]
}
```

--------------------------------

### Install pandadoc-editor 2.0 alpha

Source: https://developers.pandadoc.com/changelog/pandadoc-editor-200-alpha0

Install the 2.0 alpha version of the PandaDoc editor package. Alternatively, use `npm install pandadoc-editor@alpha` to get the latest alpha.

```bash
npm install pandadoc-editor@2.0.0-alpha.0
```

--------------------------------

### Unshare from all workspaces - request body example

Source: https://developers.pandadoc.com/reference/updatetemplatesharingsettings

Example request body for unsharing a template from all workspaces. The workspace_ids array is empty.

```json
{
  "workspace_ids": []
}
```

--------------------------------

### Create Linked Object request example

Source: https://developers.pandadoc.com/reference/link-to-crm

Example request body for creating a linked object. Specifies the CRM provider (pipedrive), entity type (deal), and entity ID (134).

```json
{
  "provider": "pipedrive",
  "entity_type": "deal",
  "entity_id": "134"
}
```

--------------------------------

### Get template settings

Source: https://developers.pandadoc.com/llms.txt

Retrieves template settings, currently only language.

```APIDOC
## Get template settings

### Description
Retrieves the settings for a specified template. Only the language field is currently supported.

### Method
GET

### Endpoint
/templates/{id}/settings

### Parameters
#### Path Parameters
- **id** (string) - Required - Template ID.

### Response
#### Success Response (200)
- **language** (string) - Template language.

#### Response Example
{
  "language": "string"
}
```

--------------------------------

### Get Template Sharing Settings

Source: https://developers.pandadoc.com/llms.txt

Retrieves template sharing settings.

```APIDOC
## Get Template Sharing Settings

### Description
Retrieves template sharing settings.

### Method
GET

### Endpoint
/templates/{id}/shares

### Parameters
#### Path Parameters
- **id** (string) - Required - Template ID.

### Response
#### Success Response (200)
- **shares** (array) - List of sharing settings.

#### Response Example
{
  "shares": []
}
```

--------------------------------

### Field Tags Example

Source: https://developers.pandadoc.com/reference/create-document-section

Example of a fields object with field tags for textfield, dropdown, checkbox, date, and signature. The role must match a recipient's role, and underscores are not allowed in role names when a file has a Field Tag.

```json
  "fields": {  
    "textfield": {  
        "value": "Jane",
        "role": "user"
    },
    "dropdown": {
        "value": "opt1",
        "role": "user",
        "options":[
          "opt1",
          "opt2",
          "opt3"
        ]
    },
    "checkbox": {  
        "value": true,
          "role": "user"
    },
    "date":{
        "value": "2022-05-20",
        "role": "user"
    },
    "signature": {  
        "value": "",
        "role": "user"
    }
  }

```

--------------------------------

### GET /workspaces

Source: https://developers.pandadoc.com/reference/list-workspaces

Documentation for the List Workspaces endpoint, including response schema and authentication details.

```APIDOC
## GET /workspaces

### Description
Retrieves a list of workspaces in the organization.

### Method
GET

### Endpoint
/workspaces

### Parameters
No parameters are documented.

### Request Example
No request body is required.

### Response
#### Success Response (200)
- **total** (integer) - A number of workspaces
- **results** (array) - List of workspace objects
  - **id** (string) - A unique identifier of a workspace in a organization
  - **name** (string) - A workspace's name
  - **date_created** (string) - A workspace's date creation
  - **owner** (string, email) - A owner's email address

#### Response Example
{
  "total": 2,
  "results": [
    {
      "id": "ajnN7eGutJZsRKjQrNuPkh",
      "name": "Test workspace",
      "date_created": "2021-06-17T15:51:13.226974Z",
      "owner": "josh@example.com"
    }
  ]
}

### Error Handling
- **401** - Authentication error
  - **type** (string) - Error type, e.g., "authentication_error"
  - **detail** (string) - Error detail message
- **403** - Permission error
  - **type** (string) - Error type, e.g., "permissions_error"
  - **detail** (string or object) - Error details, either a human-readable message or a structured object
  - **info_message** (string) - Human-readable explanation of the permission error
  - **links** (array) - Optional links related to the error

### Authentication
- **API Key** (apiKey) - 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.
- **OAuth2** (authorizationCode) - Send the authenticating user to the PandaDoc OAuth2 request URL. Request `read`, `write`, or both as space-separated `read write`. `read+write` is deprecated.
```

--------------------------------

### Field Tags Example for Document Section from Upload

Source: https://developers.pandadoc.com/reference/create-document-section-from-upload

Example of the fields object for a document section created from a file, showing supported field types (textfield, dropdown, checkbox, date, signature) with their values and roles. Note that underscores are not supported in role names for files with a Field Tag.

```json
"fields": {  
        "textfield": {  
            "value": "Jane",
            "role": "user"
        },
        "dropdown": {
            "value": "opt1",
            "role": "user",
            "options":[
              "opt1",
              "opt2",
              "opt3"
            ]
        },
        "checkbox": {  
            "value": true,
            "role": "user"
        },
        "date":{
            "value": "2022-05-20",
            "role": "user"
        },
        "signature": {  
            "value": "",
            "role": "user"
        }
    }

```

--------------------------------

### Create and open a Signing instance

Source: https://developers.pandadoc.com/docs/signing-session-embed

Import the Signing class, create a signing instance with the container element ID, configuration options (width, height, sessionId), and optional region, then open the signing session. Requires a Session ID generated via the Create Document Session endpoint.

```typescript
import { Signing } from "pandadoc-signing";

const signing = new Signing(
  "signing-container", // ID of the container element
  {
    width: 800,
    height: 600,
    sessionId: "Session ID from API",
  },
  {
    region: "com", // Optional: 'com' or 'eu'
  }
);

await signing.open();
```

--------------------------------

### Cursor MCP Configuration with Existing Server

Source: https://developers.pandadoc.com/docs/getting-started-with-mcp

Example showing how to add the PandaDoc MCP server to an existing mcp.json configuration, ensuring proper comma placement.

```json
{
  "mcpServers": {
    "mcp-sample-server": {
      "url": "https://mcp.sample.server.com/mcp"
    },
    "pandadoc": {
      "url": "https://mcp.pandadoc.com/v1/mcp"
    }
  }
}
```

--------------------------------

### Dynamics Custom Sections Example: opportunity_getProducts with sections

Source: https://developers.pandadoc.com/docs/custom-dynamics-functions

Fetches products and groups them into custom sections based on whether the product name starts with 'test'. Adds section headers to the pricing table items.

```javascript
function opportunity_getProducts(entity) {
    var deferred = $.Deferred();

    $.ajax({
        type: "GET",
        contentType: "application/json; charset=utf-8",
        dataType: "json",
        url: encodeURI(Xrm.Page.context.getClientUrl() + "/XRMServices/2011/OrganizationData.svc/" + "OpportunitySet(guid'" + entity.OpportunityId + "')/product_opportunities?$expand=opportunity_products&$orderby=SequenceNumber"),
        beforeSend: function (xmlHttpRequest) {
            xmlHttpRequest.setRequestHeader("Accept", "application/json");
        }
    }).then(function (result) {
        var items = [];
        var anotherProducts = [];
        //custom section
        items.push({
            isSection: true,
            name: "Products that start with 'test'"
        });
        result.d.results.map(function (op) {
            var product = {
                sku: op.OpportunityProductId,
                name: op.ProductDescription || (op.ProductId ? op.ProductId.Name : ""),
                price: parseFloat(op.PricePerUnit.Value),
                qty: parseFloat(op.Quantity),
                description: (op.opportunity_products && op.opportunity_products.Description) || op.Description || "",
                currency: op.TransactionCurrencyId.Name || "",
                custom_fields: {}
            };
            if (product.name.startsWith('test')) {
                items.push(product);
            } else {
                anotherProducts.push(product);
            }
        });
        if (anotherProducts.length > 0) {
            items.push({
                isSection: true,
                name: "Another products"
            });
            items = items.concat(anotherProducts);
        }
        deferred.resolve(items);
    });

    return deferred.promise();
}
```

--------------------------------

### Redirect requested event handler

Source: https://developers.pandadoc.com/docs/javascript-form-embed

Example of subscribing to the 'redirect_requested' event. Validates that redirectUrl is a non-empty string before navigating.

```javascript
events: {
  redirect_requested: function (data) {
    if (typeof data.redirectUrl === 'string' && data.redirectUrl) {
      window.location.assign(data.redirectUrl);
    }
  }
}
```

--------------------------------

### Reload form after submission

Source: https://developers.pandadoc.com/docs/javascript-form-embed

Complete HTML example that embeds a PandaDoc form in an iframe and reloads the page one second after the form is completed. Includes event handling for loaded, started, completed, and exception events.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>

<div id='form-container-YOUR_FORM_ID'></div>
<script type="text/javascript">
    (function () {
        var config = {
            nodeId: 'form-container-YOUR_FORM_ID',
            width: '100%',
            height: '700px',
            url: 'https://form.pandadoc.com/form/YOUR_FORM_HASH',
            events: {
                loaded: function () {},
                started: function (data) {},
                completed: function (data) {
                    // Reload the page one second after the form is completed.
                    setTimeout(function () {
                        window.location.reload();
                    }, 1000);
                },
                exception: function (data) {}
            },
            data: {},
        };
        const dataQueryString = config.data ? Object.keys(config.data)
            .map(function (key) {
                return '&' + key + '=' + encodeURIComponent(JSON.stringify(config.data[key]));
            })
            .join('') : '';
        var iframe = document.createElement('iframe');
        iframe.frameBorder = 0;
        iframe.src = config.url + dataQueryString;
        if (config.nodeId) {
            var node = document.getElementById(config.nodeId);
            node.style.height = config.height;
            node.style.width = config.width;
            iframe.height = '100%';
            iframe.width = '100%';
            node.append(iframe);
        } else {
            iframe.height = config.height;
            iframe.width = config.width;
            document.body.append(iframe);
        }
        var eventMethod = window.addEventListener ? 'addEventListener' : 'attachEvent';
        var messageEvent = eventMethod === 'attachEvent' ? 'onmessage' : 'message';
        window[eventMethod](messageEvent, function (e) {
            if (e && e.data && config && iframe && e.source === iframe.contentWindow) {
                try {
                    var message = JSON.parse(e.data);
                    if (message && message.event) {
                        var event = message.event.replace('embed.form.', '');
                        var callback = config.events ? config.events[event] : null;
                        if (callback) {
                            callback(message.data);
                        }
                    }
                } catch (e) {
                    console.log(e);
                }
            }
        }, false);
    })();
</script>
</body>
</html>
```

--------------------------------

### Initialize and open the editor

Source: https://developers.pandadoc.com/docs/embedded-editing-e-token

Create an Editor instance with the container ID and options, then open it with an E-Token. The token is optional during initialization but required when opening.

```typescript
import { Editor } from "pandadoc-editor";

const editor = new Editor(
    "editor-container",
    {
      fieldPlacementOnly: false,
      token: "", // E-Token is optional during initialization
    }
);

await editor.open({
    token: "your-e-token"
});
```

--------------------------------

### Create and open an Editor instance

Source: https://developers.pandadoc.com/docs/editor-embed

Import the Editor class and create an editor instance with a container ID, configuration (width, height, token), and open it. Requires a valid E-Token generated via the Public API.

```typescript
import { Editor } from 'pandadoc-editor';

const editor = new Editor(
  'editor-container', // ID of the container element
  {
    width: 800,
    height: 600,
    token: 'Edit session E-Token',
  }
);

editor.open();
```

--------------------------------

### GET /webhook-subscriptions/{uuid}

Source: https://developers.pandadoc.com/llms.txt

Get webhook subscription by uuid.

```APIDOC
## [GET] /webhook-subscriptions/{uuid}

### Description
Get webhook subscription by uuid.

### Method
GET

### Endpoint
/webhook-subscriptions/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - UUID of the webhook subscription.

### Response
#### Success Response (200)
- **id** (string) - UUID of the webhook subscription.
- **name** (string) - Name of the webhook subscription.
- **url** (string) - URL of the webhook subscription.
- **events** (array) - List of subscribed events.

#### Response Example
{
  "id": "uuid",
  "name": "My Webhook",
  "url": "https://example.com/webhook",
  "events": ["document.state_changed"]
}
```

--------------------------------

### GET /documents/folders

Source: https://developers.pandadoc.com/llms.txt

Get the list of folders which contain Documents in your account.

```APIDOC
## GET /documents/folders

### Description
Get the list of folders which contain Documents in your account. The root folder is not listed in the response.

### Method
GET

### Endpoint
/documents/folders

### Response
#### Success Response (200)
- **folders** (array) - List of folders.

#### Response Example
{
  "folders": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}
```

--------------------------------

### Signing order example

Source: https://developers.pandadoc.com/reference/create-document-section

Configures a recipient with a signing order for document section sections created from a file. The role is used to match field tags and must be provided in the payload.

```json
  "recipients": [  
    {  
      "email": "josh@example.com",
      "first_name": "Josh",
      "last_name": "Ron",
      "role": "user",
      "signing_order": 1
    }
  ]

```

--------------------------------

### GET /documents/{document_id}/linked-objects

Source: https://developers.pandadoc.com/llms.txt

Get a list of linked objects for the document.

```APIDOC
## GET /documents/{document_id}/linked-objects

### Description
Get a list of linked objects for the document.

### Method
GET

### Endpoint
/documents/{document_id}/linked-objects

### Parameters
#### Path Parameters
- **document_id** (string) - Required - The unique identifier of the document.

### Response
#### Success Response (200)
- **linked_objects** (array) - List of linked objects.

#### Response Example
{
  "linked_objects": [
    {
      "id": "linked_object_id",
      "provider": "salesforce"
    }
  ]
}
```

--------------------------------

### Create Template request and 201 response for POST /public/v1/templates

Source: https://developers.pandadoc.com/reference/create-template

Shows the request body for creating a template via the /public/v1/templates endpoint hat includes sample values for name, folder_uuid, owner, and metadata, followed by the expected 201 response with the new template's id, timestamps, and version.

```json
{
  "name": "Sample Template",
  "folder_uuid": "EE8yUNg5HztqVAuH85He8V",
  "owner": {
    "email": "john.doe@example.com"
  },
  "metadata": {
    "my_favorite_pet": "Panda"
  }
}
```

```json
{
  "id": "va9aNuj3uX2w9M7uytn967",
  "name": "Sample Template",
  "date_created": "2024-07-08T14:41:42.625906Z",
  "date_modified": "2024-07-08T14:41:42.700084Z",
  "version": "2"
}
```

--------------------------------

### DocEditor Full Init

Source: https://developers.pandadoc.com/docs/pandadocjs

Initializes a PandaDoc document editor with full data configuration, including recipients, widgets (fields), tokens, pricing table items, and metadata. Use editor.showAsModal() instead of editor.show() to load as a modal overlay. Place within a <script> tag.

```javascript
var editor = new PandaDoc.DocEditor();
editor.show({
    el: '#ELEMENT_ID',
    data: {
        docName: 'Document Name',
        recipients: [{
          first_name: "John",
          last_name: "Appleseed",
          email: "john@appleseed.com",
          title: "Dr.",
          phone: "+1 415-012-3456",
          company: "Sample Company",
          country: "USA",
          postal_code: "90210",
          state: "CA",
          city: "Anytown",
          street_address: "123 Main Street",
          //will be automatically assigned to a specific role in a template
          roleName: "ROLE_IN_A_TEMPLATE"
        }],
        //populate fields in a template
        widgets: {
          FIELD_TITLE: 'FIELD_DATA'
        },
        //populate tokens in a template
        tokens: {
          TOKEN_NAME: 'TOKEN_VALUE',
        },
        //populate a pricing table in a template
        items: [{
            sku: 'A1234',
            name: 'Sample Product',
            price: 100,
            qty: 1,
            description: 'Description of a product',
            currency: 'USD',
            custom_fields: {
                location : 'California'
            }
        }],
        metadata: {
        	YOUR_META_KEY: 'YOUR_META_VALUE'
        }
    },
    cssClass: 'CUSTOM_CSS_CLASS',
    events: {
        onInit: function(){},
        onDocumentCreated: function(){},
        onDocumentSent: function(){},
        onClose: function(){}
    }
});
```

--------------------------------

### Create Webhook Subscription for document_completed_pdf_ready

Source: https://developers.pandadoc.com/docs/how-to-download-completed-document

Use this curl command to create a webhook subscription that triggers on the `document_completed_pdf_ready` event. Replace `YOUR_API_TOKEN` with your API token and the `url` with your webhook endpoint. The `active` field is set to true.

```bash
curl -X POST "https://api.pandadoc.com/public/v1/webhook-subscriptions" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "PDF Download Webhook",
    "url": "https://your-domain.com/webhook-handler",
    "triggers": ["document_completed_pdf_ready"],
    "active": true
  }'
```

--------------------------------

### Complete HTML implementation with iframe and event handling

Source: https://developers.pandadoc.com/docs/handle-post-completion-actions-embedded-signing

Complete HTML page that embeds a PandaDoc signing iframe and handles post-completion events. It listens for messages from https://app.pandadoc.com and reacts to session_view.document.loaded, session_view.document.completed, and session_view.document.exception events. Includes placeholder functions for hiding the loading spinner, showing success/error messages, redirecting to a thank-you page, and notifying a backend.

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Document Signing</title>
    <style>
      #pandadoc-iframe {
        width: 100%;
        height: 600px;
        border: none;
      }
      #loading-spinner,
      #success-message,
      #error-message {
        display: none;
        padding: 20px;
        text-align: center;
      }
      #success-message {
        background-color: #d4edda;
        color: #155724;
        border: 1px solid #c3e6cb;
      }
      #error-message {
        background-color: #f8d7da;
        color: #721c24;
        border: 1px solid #f5c6cb;
      }
    </style>
  </head>
  <body>
    <div id="loading-spinner">
      <p>Loading document...</p>
    </div>

    <div id="signing-instructions" style="display: none">
      <p>Please review and sign the document below:</p>
    </div>

    <iframe
      id="pandadoc-iframe"
      src="https://app.pandadoc.com/s/qU89rB4r33FdM5NQTcAWKj/"
    ></iframe>

    <div id="success-message">
      <h3>Document Signed Successfully!</h3>
      <p>
        Thank you for completing the document. You will be redirected shortly.
      </p>
    </div>

    <div id="error-message"></div>

    <script>
      showLoadingSpinner();
      // Event listener implementation from steps above
      window.addEventListener("message", (event) => {
        if (event.origin !== "https://app.pandadoc.com") {
          return;
        }

        const type = event.data && event.data.type;
        const payload = event.data && event.data.payload;

        switch (type) {
          case "session_view.document.loaded":
            handleDocumentLoaded(payload);
            break;
          case "session_view.document.completed":
            handleDocumentCompleted(payload);
            break;
          case "session_view.document.exception":
            handleDocumentException(payload);
            break;
        }
      });

      function handleDocumentLoaded(payload) {
        console.log("Document loaded successfully");

        // Example: Hide loading spinner
        document.getElementById("loading-spinner").style.display = "none";

        // Example: Show signing instructions
        document.getElementById("signing-instructions").style.display = "block";
      }

      function handleDocumentException(payload) {
        console.error("Document exception:", payload);

        // Example: Show error message
        showErrorMessage("An error occurred during signing. Please try again.");

        // Example: Log error for debugging
        logError("Embedded signing error", payload);
      }

      function showErrorMessage(message) {
        const errorDiv = document.getElementById("error-message");
        errorDiv.textContent = message;
        errorDiv.style.display = "block";
      }

      function logError(message, payload) {
        // Send error information to your logging system
        console.error(message, payload);
      }

      function showLoadingSpinner() {
        document.getElementById("loading-spinner").style.display = "block";
      }

      function handleDocumentCompleted(payload) {
        console.log("Document completed:", payload);

        // Example: Close the iframe and show success message
        closeSigningIframe();
        showSuccessMessage();

        // Example: Redirect to a custom page
        redirectToThankYouPage();

        // Example: Update your application's state
        updateDocumentStatus("completed");

        // Example: Send completion data to your backend
        notifyBackend(payload);
      }

      function closeSigningIframe() {
        const iframe = document.getElementById("pandadoc-iframe");
        if (iframe) {
          iframe.remove();
        }
      }

      function redirectToThankYouPage() {
        // Custom redirect logic
        // window.location.href = "/thank-you?document=completed";
      }

      function showSuccessMessage() {
        // Show custom success UI
        document.getElementById("success-message").style.display = "block";
      }

      function updateDocumentStatus(status) {
        // Update your application's document tracking
        // This could involve API calls to your backend
      }

      function notifyBackend(payload) {
        // Send completion event to your backend for processing
      }
    </script>
  </body>
</html>
```

--------------------------------

### GET /linked-objects/{linked_object_id}/documents

Source: https://developers.pandadoc.com/llms.txt

Get a list of documents connected to a linked object - an entity from an integration.

```APIDOC
## GET /linked-objects/{linked_object_id}/documents

### Description
Get a list of documents connected to a linked object - an entity from an integration.

### Method
GET

### Endpoint
/linked-objects/{linked_object_id}/documents

### Parameters
#### Path Parameters
- **linked_object_id** (string) - Required - The unique identifier of the linked object.

### Response
#### Success Response (200)
- **documents** (array) - List of documents connected to the linked object.

#### Response Example
{
  "documents": [
    {
      "id": "document_id",
      "name": "Document Name"
    }
  ]
}
```

--------------------------------

### Create Document with Passcode Verification

Source: https://developers.pandadoc.com/docs/enable-verification

A full example of creating a document from a template with a recipient configured for passcode verification. Replace the template_uuid and role with values specific to your workspace.

```json
{
    "name": "One Signer with Recipient Verification",
    "template_uuid": "Pw3syYYAvTU2h3Tx6vqatG",
    "recipients": [
        {
            "role": "Client",
            "first_name": "Signer",
            "last_name": "One",
            "email": "signer.one@example.com",
            "verification_settings": {
                "verification_place": "before_open",
                "passcode_verification": {
                    "passcode": "SimpleCode1"
                }
            }
        }
    ]
}
```

--------------------------------

### DocEditor Simple Init

Source: https://developers.pandadoc.com/docs/pandadocjs

Initializes a PandaDoc document editor and shows it in a page element. Use editor.showAsModal() instead of editor.show() to load as a modal overlay. Place within a <script> tag.

```javascript
var editor = new PandaDoc.DocEditor();
editor.show({ 
    el: '#ELEMENT_ID',
    data: {
        metadata: {
            YOUR_META_KEY: 'YOUR_META_VALUE'
        }
    },
    cssClass: 'CUSTOM_CSS_CLASS',
    events: {
        onInit: function(){},
        onDocumentCreated: function(){},
        onDocumentSent: function(){},
        onClose: function(){}
    }
});
```

--------------------------------

### Get User Details by ID

Source: https://developers.pandadoc.com/llms.txt

Get detailed information about a specific user by their ID. Requires organization admin.

```APIDOC
## Get User Details by ID

### Description
Get detailed information about a specific user by their ID, including contact information, license type, and workspace roles. You must be an organization admin to get user details.

### Method
GET

### Endpoint
https://developers.pandadoc.com/reference/detailsuser.md

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The ID of the user.

### Response
#### Success Response (200)
- **id** (string) - The user ID.
- **email** (string) - The user's email.
- **license** (string) - The user's license type.
- **roles** (array) - The user's workspace roles.

#### Response Example
```json
{
  "id": "user_id",
  "email": "user@example.com",
  "license": "business",
  "roles": []
}
```
```

--------------------------------

### Create Template

Source: https://developers.pandadoc.com/llms.txt

Creates a new template with the provided details.

```APIDOC
## Create Template

### Description
This operation allows you to create a new template by providing the necessary template details.

### Method
POST

### Endpoint
/templates

### Request Body
- **name** (string) - Required - Template name.
- **template** (object) - Required - Template details.

### Request Example
{
  "name": "string",
  "template": {}
}

### Response
#### Success Response (201)
- **id** (string) - Template ID.

#### Response Example
{
  "id": "string"
}
```

--------------------------------

### Started event payload

Source: https://developers.pandadoc.com/docs/javascript-form-embed

Payload for the 'started' event, containing an array of recipient objects with first_name, last_name, and email fields.

```javascript
{
  recipients: [{
    first_name: 'John',
    last_name: 'Doe',
    email: 'johndoe@gmail.com'
  }],
}
```

--------------------------------

### Initialize and open editor in field-placement mode

Source: https://developers.pandadoc.com/docs/embedded-sending-e-token

Initialize the editor in field-placement-only mode and open it with an E-Token. The token is optional during initialization but required when calling open().

```typescript
import { Editor } from "pandadoc-editor";

const editor = new Editor(
    "editor-container",
    {
      fieldPlacementOnly: true,
      token: "", // E-Token is optional during initialization
    }
);

await editor.open({
    token: "your-e-token"
});
```

--------------------------------

### GET /api-logs

Source: https://developers.pandadoc.com/llms.txt

Get the list of all logs within the selected workspace. Optionally filter by date, page, and number of items per page.

```APIDOC
## [GET] /api-logs

### Description
Get the list of all logs within the selected workspace. Optionally filter by date, page, and number of items per page.

### Method
GET

### Endpoint
/api-logs

### Parameters
#### Query Parameters
- **date** (string) - Optional - Filter logs by date.
- **page** (integer) - Optional - Page number for pagination.
- **per_page** (integer) - Optional - Number of items per page.

### Response
#### Success Response (200)
- **results** (array) - List of API logs.
- **meta** (object) - Pagination metadata.

#### Response Example
{
  "results": [],
  "meta": {}
}
```

--------------------------------

### Create User

Source: https://developers.pandadoc.com/llms.txt

Create users and assign them roles, licenses, and workspaces. Requires organization admin. Email domain must match organization domain.

```APIDOC
## Create User

### Description
Create users, and assign them roles, licenses, and workspaces. You must be an organization admin to create users. We check that the user email domain matches your organization domain.

### Method
POST

### Endpoint
https://developers.pandadoc.com/reference/create-user.md

### Parameters
#### Request Body
- **email** (string) - Required - The email address of the user.
- **role** (string) - Required - The role to assign to the user.
- **license** (string) - Required - The license type to assign.
- **workspaces** (array) - Optional - List of workspace IDs to assign the user to.

### Request Example
```json
{
  "email": "user@example.com",
  "role": "admin",
  "license": "business"
}
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the created user.
- **email** (string) - The email of the created user.

#### Response Example
```json
{
  "id": "user_id",
  "email": "user@example.com"
}
```
```

--------------------------------

### GET /public/v1/documents/{id}/details

Source: https://developers.pandadoc.com/reference/document-details

This snippet documents the GET endpoint for retrieving document details, including its parameters, response schema, and error responses.

```APIDOC
## GET /public/v1/documents/{id}/details

### Description
Retrieves detailed information about a specific document, including its status, QES status, approval execution details, version, and lock information.

### Method
GET

### Endpoint
/public/v1/documents/{id}/details

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the document.

### Response
#### Success Response (200)
- **id** (string) - The document identifier.
- **status** (DocumentStatusEnum) - The current status of the document.
- **qes_status** (DocumentQESStatusEnum, nullable) - The status of the QES (Qualified Electronic Signature) for the document. Null if QES is disabled.
- **approval_execution** (object, nullable) - Document approval execution details.
  - **document_uuid** (string) - Decoded uuid of related RegularDocument instance.
  - **revision_number** (integer) - Consequent number of revision for related RegularDocument.
- **version** (string) - Document version.
- **lock** (DocumentLockInfo, nullable) - Active editing lock on the document, if any. `null` when the document is not locked or the lock has expired.

#### Response Example
{
  "id": "string",
  "status": "string",
  "qes_status": "string",
  "approval_execution": {
    "document_uuid": "1234567890",
    "revision_number": 1
  },
  "version": "1",
  "lock": {}
}

#### Error Responses
- **401** - Authentication error. Response includes `type` (e.g., "authentication_error") and `detail` (e.g., "Authentication credentials were not provided.").
- **403** - Permission error. Response includes `type` (e.g., "permissions_error"), `detail` (string or object), `info_message` (string), and optional `links` array.
- **404** - Not found. Response includes `type` (e.g., "request_error") and `detail` (e.g., "Not found").
- **409** - Conflict. Response includes `id` (string).
```

--------------------------------

### GET /public/v1/sms/opt-outs/changelog

Source: https://developers.pandadoc.com/reference/listrecentsmsoptouts

This snippet documents the GET endpoint for listing SMS opt-out changelog entries. It includes the endpoint path, authentication methods, response schema, and error responses.

```APIDOC
## GET /public/v1/sms/opt-outs/changelog

### Description
Retrieves a list of SMS opt-out changes (opt-in/opt-out events) for phone numbers. This endpoint returns a changelog of SMS opt-out status changes.

### Method
GET

### Endpoint
/public/v1/sms/opt-outs/changelog

### Authentication
- **apiKey** (header) - Required - 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.
- **oauth2** - Required - Send the authenticating user to the PandaDoc OAuth2 request URL. Request `read`, `write`, or both as space-separated `read write`. `read+write` is deprecated.

### Response
#### Success Response (200)
- **results** (array) - List of SMS opt-out changelog entries.
  - **phone_number** (string) - The phone number, e.g., "+1234567890".
  - **status** (string) - The status of the phone number, either "opt-in" or "opt-out".
  - **opt_out_changed** (string, date-time) - The timestamp when the opt-out status changed, e.g., "2025-01-28T12:00:00Z".

#### Response Example
```json
{
  "results": [
    {
      "phone_number": "+1234567890",
      "status": "opt-out",
      "opt_out_changed": "2025-01-28T12:00:00Z"
    }
  ]
}
```

### Error Responses
- **400** - Request error
- **401** - Authentication error
- **403** - Permission error
- **429** - Rate limit exceeded
```

--------------------------------

### POST /templates

Source: https://developers.pandadoc.com/reference/create-template-from-file

Creates a new template from a file upload. The file must be a binary PDF, DocX, or RTF file, and the template data is provided as a multipart/form-data string.

```APIDOC
## POST /templates

### Description
Creates a new template from a file upload. The file must be a binary PDF, DocX, or RTF file, and the template data is provided as a multipart/form-data string.

### Method
POST

### Endpoint
/templates

### Parameters
#### Request Body
- **file** (string, binary) - Required - Binary PDF/DocX/RTF File.
- **data** (object) - Required - JSON as a multipart/form-data string. Contains the template creation data.

### Request Example
```json
{
  "file": "<binary file>",
  "data": {
    "name": "string",
    "template_type": "string",
    "content_placeholders": [
      {
        "name": "string",
        "example": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "recipients": [
      {
        "role": "string",
        "name": "string",
        "email": "user@example.com"
      }
    ],
    "metadata": {
      "key": "value"
    },
    "tokens": {}
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - Template ID.
- **name** (string) - Template name.
- **date_created** (string) - Creation date.
- **date_modified** (string) - Last modification date.
- **creator** (object) - Creator details.
- **shared** (boolean) - Whether the template is shared.
- **status** (string) - Template status.
- **template_type** (string) - Template type.
- **content_placeholders** (array) - Placeholders in the template.
- **tags** (array) - Tags associated with the template.
- **recipients** (array) - Recipients list.
- **metadata** (object) - Custom metadata.
- **tokens** (object) - Token information.

#### Response Example
```json
{
  "id": "string",
  "name": "string",
  "date_created": "string",
  "date_modified": "string",
  "creator": {
    "id": "string",
    "email": "user@example.com"
  },
  "shared": true,
  "status": "string",
  "template_type": "string",
  "content_placeholders": [
    {
      "name": "string",
      "example": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "recipients": [
    {
      "role": "string",
      "name": "string",
      "email": "user@example.com"
    }
  ],
  "metadata": {
    "key": "value"
  },
  "tokens": {}
}
```

### Error Responses
#### 401 Unauthorized
- **type** (string) - Error type, e.g., "authentication_error".
- **detail** (string) - Error detail, e.g., "Authentication credentials were not provided.".

#### 429 Too Many Requests
- **type** (string) - Error type, e.g., "throttled".
- **detail** (string) - Error detail, e.g., "Request was throttled.".

#### 400 Bad Request
- **type** (string) - Error type, e.g., "validation_error".
- **detail** (object) - Validation error details.

```

--------------------------------

### Create document request with content_placeholders

Source: https://developers.pandadoc.com/docs/create-with-content-placeholders-from-template

Build the create document request body with a content_placeholders array. Each placeholder references a block_id and an array of content_library_items; items can include pricing_tables, recipients, and fields. Use template_uuid and recipient details as shown.

```json
{
    "name": "API Sample Document for PandaDoc Template",
    "template_uuid": "{{template_id}}",
    "recipients": [
        {
            "email": "jane@example.net",
            "first_name": "Jane",
            "last_name": "Roe"
        }
    ],
    "content_placeholders": [
        {
            "block_id": "{{block_id}}",
            "content_library_items": [
                {
                    "id": "{{cli_id}}",
                    "pricing_tables": [
                        {
                            "name": "Pricing Table 1",
                            "options": {
                                "currency": "USD",
                                "discount": {
                                    "is_global": true,
                                    "type": "absolute",
                                    "name": "Discount",
                                    "value": 2.26
                                }
                            },
                            "sections": [
                                {
                                    "title": "Sample Section",
                                    "default": true,
                                    "rows": [
                                        {
                                            "options": {
                                                "optional": true,
                                                "optional_selected": true,
                                                "qty_editable": true
                                            },
                                            "data": {
                                                "name": "Placeholder Panda",
                                                "price": 10,
                                                "qty": 3
                                            }
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "{{cli_id_2}}",
                    "recipients": [
                        {
                            "email": "john@example.net",
                            "first_name": "John",
                            "last_name": "Roe",
                            "role": "Signer"
                        }
                    ],
                    "fields": {
                        "Date": {
                            "value": "2019-12-31T00:00:00.000Z"
                        }
                    }
                }
            ]
        }
    ]
}
```

--------------------------------

### Create Content Library Item

Source: https://developers.pandadoc.com/llms.txt

Creates an empty content library item.

```APIDOC
## Create Content Library Item

### Description
This API endpoint allows users to create an empty item in the content library. No actual content or data is required to be provided in the initial creation.

### Method
POST

### Endpoint
/content-library-items

### Response
#### Success Response (201)
- **id** (string) - Content library item ID.

#### Response Example
{
  "id": "string"
}
```

--------------------------------

### Add CC Document Recipient request body example

Source: https://developers.pandadoc.com/reference/add-cc-recipient

Example request body for the Add Document Recipient endpoint. It specifies the contact ID and sets kind to 'contact' to add a CC recipient to a document.

```json
{
  "id": "pGkLnJUAx99JpXJy5DVD30",
  "kind": "contact"
}
```
Tokens:
Raw