> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PandaDoc

> How to set up the PandaDoc connector, plus the actions and events that are available.

![PandaDoc](https://stackone-logos.com/api/pandadoc/filled/svg)

Previewv0.2.1[See changelog](https://docs.stackone.com/connectors/pandadoc/changelog.md)

[68 actions](#actions) · [13 events](#events) · 2 auth methods

E-Signature
Documents
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/pandadoc/guides/connector-profile/api-key.md)
>
> Uses a Production or Sandbox API key. The key acts with the role of the person who generated it.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/pandadoc/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth app in the PandaDoc Developer Dashboard, which needs production API access. Tokens act as...

Optionally, configure receiving Events for PandaDoc into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/pandadoc/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/pandadoc/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/pandadoc/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

read

write

No scopes found

68 actions

ActionDescriptionRequired scopes

List Catalog Items Search`pandadoc_search_catalog_items`

This method searches for items in your product catalog.

`read`

Create Catalog Item`pandadoc_create_catalog_item`

Create a new catalog item.

`write`

Catalog Item Details`pandadoc_get_catalog_item`

Get a product catalog item by its UUID, including its pricing, SKU, category and custom fields.

`read`

Update Catalog Item`pandadoc_update_catalog_item`

Update the fields of an existing product catalog item, such as its title, pricing, SKU or category.

`write`

Delete Catalog Item`pandadoc_delete_catalog_item`

Permanently delete a product catalog item by its UUID.

`write`

List Contacts`pandadoc_list_contacts`

This method returns a list of contacts associated with a workspace.

`read`

Create Contact`pandadoc_create_contact`

This method adds a contact into a contacts list.

`write`

Contact Details`pandadoc_details_contact`

Returns contact details by its ID.

`read`

Delete Contact`pandadoc_delete_contact`

This method deletes a contact.

`write`

Update Contact`pandadoc_update_contact`

This method updates a contact details.

`write`

List Content Library Items`pandadoc_list_content_library_items`

Retrieves a list of content library items.

`read`

List Documents`pandadoc_list_documents`

This endpoint will let you list and search for the documents.

`read`

Create Document`pandadoc_create_document`

Create from a template See the Create document from template tutorial for details on how to use this endpoint, as well a...

`write`

Delete Documents (bulk)`pandadoc_bulk_delete_documents`

Delete multiple documents in one request by sending a JSON array.

`write`

Document Status`pandadoc_status_document`

It is useful to request document status to ensure a document is in the expected state before calling additional API meth...

`read`

Delete Document`pandadoc_delete_document`

Delete a PandaDoc document by its ID. Deletion is permanent by default; set forever to false to move it to the Trash Bin...

`write`

Update Document`pandadoc_update_document`

Use the PATCH method to update a PandaDoc document.

`write`

Document ESign Disclosure`pandadoc_document_e_sign_disclosure`

Retrieves the current version of eSign disclosure text for a specified document.

`read`

Document Status Change`pandadoc_change_document_status`

PandaDoc has eight document statuses, but you can manually set your document status to only four - Document statuses - C...

`write`

Move Document To Draft`pandadoc_document_revert_to_draft`

Revert your document back to draft to continue editing it.

`write`

Document Details`pandadoc_details_document`

Return detailed data about a document.

`read`

Send Document`pandadoc_send_document`

Send a draft document to its recipients for viewing, approval or signature.

`write`

Create Document Editing Session`pandadoc_create_document_editing_session`

Creates a new editing session for the Embedded Editor.

`write`

Create Document Session For Embedded Sign`pandadoc_create_document_link`

Creates a document session for a recipient to view and sign a document.

`write`

Update Document Ownership`pandadoc_transfer_document_ownership`

This operation allows transferring the ownership of a document to another user by specifying the document ID and members...

`write`

Transfer All Documents Ownership`pandadoc_transfer_all_documents_ownership`

This method transfers ownership of all documents from one member to another.

`write`

Document Move To Folder`pandadoc_document_move_to_folder`

This operation allows you to move a document to a folder by specifying the document ID and folder ID.

`write`

Append Content Library Item To A Document`pandadoc_append_content_library_item_to_document`

Appends a Content Library Item (CLI) to a document and provides a name mapping for its content blocks.

`write`

List Documents Folders`pandadoc_list_document_folders`

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

`read`

Create Documents Folder`pandadoc_create_document_folder`

Create a new folder to store your documents.

`write`

Rename Documents Folder`pandadoc_rename_document_folder`

Rename an existing documents folder by its UUID.

`write`

List Templates Folders`pandadoc_list_template_folders`

Get the list of folders that contain Templates in your account.

`read`

Create Templates Folder`pandadoc_create_template_folder`

Create a new folder to store your templates.

`write`

Rename Templates Folder`pandadoc_rename_template_folder`

Rename a templates folder.

`write`

Get Unified Credentials`pandadoc_unified_get_me`

Get the current PandaDoc connection's unified credentials and identity.

`read`

List Unified Groups`pandadoc_unified_list_groups`

List unified groups (workspaces) in a PandaDoc account.

`read`

Get Unified Group`pandadoc_unified_get_group`

Get a unified PandaDoc group (workspace) by ID.

`read`

List Unified Roles`pandadoc_unified_list_roles`

List the built-in roles of a PandaDoc account.

`read`

Get Unified Role`pandadoc_unified_get_role`

Get a built-in PandaDoc role by ID.

`read`

List Unified Users`pandadoc_unified_list_users`

List unified users in a PandaDoc account.

`read`

Get Unified User`pandadoc_unified_get_user`

Get a unified PandaDoc user by ID.

`read`

List Members`pandadoc_list_members`

List the members of the workspace the PandaDoc API key belongs to.

`read`

Get Member`pandadoc_get_member`

Get one member of the PandaDoc API key's workspace by membership ID.

`read`

Get Current Member`pandadoc_get_current_member`

Get the PandaDoc member who owns the API key.

`read`

Create Member Token`pandadoc_create_member_token`

Create a short-lived session token that lets an organization admin act as a workspace member. Available on request only.

`write`

Add Document Recipient`pandadoc_add_document_recipient`

Add an existing contact or contact group to a document as a CC recipient.

`write`

Delete Document Recipient`pandadoc_delete_document_recipient`

Remove a recipient from a document.

`write`

Update Document Recipient`pandadoc_edit_document_recipient`

Modify a recipient's personal details, or update a recipient group's name and members.

`write`

Reassign Document Recipient`pandadoc_reassign_document_recipient`

Reassign a signer's fields to another contact or contact group before the original signer has signed.

`write`

List Templates`pandadoc_list_templates`

Retrieves a list of templates.

`read`

Create Template`pandadoc_create_template`

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

`write`

Duplicate Template`pandadoc_duplicate_template`

Duplicate Template Creates a copy of a template within the same workspace.

`write`

Template Details`pandadoc_details_template`

Get details about a template by id.

`read`

Delete Template`pandadoc_delete_template`

Delete a PandaDoc template by its ID.

`write`

Template Status`pandadoc_status_template`

Available Template Statuses The following is a complete list of all possible template statuses returned - | Template Sta...

`read`

Template Update`pandadoc_update_template`

Update a processed template, including its variables (tokens) and its roles.

`write`

Create Template Editing Session`pandadoc_create_template_editing_session`

Creates a new editing session for the Embedded Editor.

`write`

List Users`pandadoc_list_users`

List the users in the PandaDoc organization with their licenses and workspace roles.

`read`

Get User`pandadoc_get_user`

Get one PandaDoc user by user ID.

`read`

Create User`pandadoc_create_user`

Create users, and assign them roles, licenses, and workspaces.

`write`

List Workspaces`pandadoc_list_workspaces`

List the workspaces in the PandaDoc organization.

`read`

Add Member To Workspace`pandadoc_add_member_to_workspace`

Add an existing PandaDoc user to a workspace with a role.

`write`

Change Member Role`pandadoc_change_member_role`

Change the role of a member in a PandaDoc workspace.

`write`

Remove Member From Workspace`pandadoc_remove_member_from_workspace`

Remove a member from a PandaDoc workspace.

`write`

Create Workspace`pandadoc_create_workspace`

Create a workspace in your organization.

`write`

Deactivate Workspace`pandadoc_deactivate_workspace`

Deactivate the workspace, remove all the members from it and make it unavailable.

`write`

Create API Key`pandadoc_create_api_key`

Generate a new API key for the workspace.

`write`

\[Beta] Update Workspace`pandadoc_update_workspace`

Update a workspace's name and branding.

`write`

## Events

Tags

Select all
|
Clear

Content Library Items

Documents

Templates

Webhooks

No tags found

13 events

EventDescriptionTags

Document State Changed Webhook`pandadoc_webhook_document_state_changed`

Processes PandaDoc document\_state\_changed webhook events, sent when a document's status changes (draft, sent, viewed, co...

DocumentsWebhooks

Document Completed PDF Ready Webhook`pandadoc_webhook_document_completed_pdf_ready`

Processes PandaDoc document\_completed\_pdf\_ready webhook events, sent when a document is completed and its PDF has been s...

DocumentsWebhooks

Document Updated Webhook`pandadoc_webhook_document_updated`

Processes PandaDoc document\_updated webhook events, sent when a document is returned to draft.

DocumentsWebhooks

Recipient Completed Webhook`pandadoc_webhook_recipient_completed`

Processes PandaDoc recipient\_completed webhook events, sent when a recipient completes a document (data.action\_by and da...

DocumentsWebhooks

Document Deleted Webhook`pandadoc_webhook_document_deleted`

Processes PandaDoc document\_deleted webhook events, sent when a document is removed.

DocumentsWebhooks

Document Creation Failed Webhook`pandadoc_webhook_document_creation_failed`

Processes PandaDoc document\_creation\_failed webhook events, sent when asynchronous document creation through the API fai...

DocumentsWebhooks

Document Section Added Webhook`pandadoc_webhook_document_section_added`

Processes PandaDoc document\_section\_added webhook events, sent when asynchronous creation of a document section complete...

DocumentsWebhooks

Quote Updated Webhook`pandadoc_webhook_quote_updated`

Processes PandaDoc quote\_updated webhook events, sent when a quote is saved in the Quote Builder.

DocumentsWebhooks

Template Created Webhook`pandadoc_webhook_template_created`

Processes PandaDoc template\_created webhook events, sent when a template is created.

TemplatesWebhooks

Template Updated Webhook`pandadoc_webhook_template_updated`

Processes PandaDoc template\_updated webhook events, sent when a template's name, roles or sections change.

TemplatesWebhooks

Template Deleted Webhook`pandadoc_webhook_template_deleted`

Processes PandaDoc template\_deleted webhook events, sent when a template is deleted.

TemplatesWebhooks

Content Library Item Created Webhook`pandadoc_webhook_content_library_item_created`

Processes PandaDoc content\_library\_item\_created webhook events, sent when a content library item is created.

Content Library ItemsWebhooks

Content Library Item Creation Failed Webhook`pandadoc_webhook_content_library_item_creation_failed`

Processes PandaDoc content\_library\_item\_creation\_failed webhook events, sent when asynchronous content library item crea...

Content Library ItemsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.