Skip to main content
PandaDoc logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: PANDADOC
  • Version: 20261101_00

Tools

Slug: PANDADOC_ADD_DOCUMENT_RECIPIENTAdd a document recipient. Add a CC recipient to a document. > 🚧 Before you start > > To add a CC recipient, please ensure that: > > - You have the ‘Can Manage Recipients’ permission. > - This recipient is already created in your contacts. If not, add them using the Create Contact endpoint. To add a new CC recipient to a document, two parameters must be included in the request body: - kind: Set this parameter to contact to specify an individual contact, or contact_group to specify a contact group. - id: Input the ID of the desired contact (for kind: contact) or contact group (for kind: contact_group). To retrieve the contact’s ID, use the List Contacts endpoint to access a list of all contacts, and then locate the desired contact by sea

Input Parameters

string
required
Document UUID
object
required
Request body as documented by PandaDoc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_ADD_WORKSPACE_MEMBERAdd a workspace member. Add an existing user to a workspace. - You must be an organization admin or a workspace admin to add members.

Input Parameters

string ("Admin" | "Manager" | "Member" | "Collaborator")
required
Role.
string
required
User id.
boolean
Send a confirmation email to the user that was added to workspace(s).
string
required
Workspace id.
boolean
Send a confirmation email to all workspace admins indicating that the user has been added to the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_APPEND_CONTENT_LIBRARY_ITEM_TO_DOCUMENTAppend a content library item to a document. Appends a Content Library Item (CLI) to a document and provides a name mapping for its content blocks.

Input Parameters

string
required
Specify document id.
object
Settings to append a CLI to a document, with ability to change some parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_BULK_DELETE_DOCUMENTSBulk-delete documents. Delete multiple documents in one request by sending a JSON array. Each element must be an object with an id field (the document ID, same value as elsewhere in the Documents API). The caller must have permission to delete each document. Documents must belong to the authenticated workspace. This batch operation returns 200 OK with a JSON body containing an id array of deleted document IDs. That differs from Delete Document (DELETE /public/v1/documents/{id}), which returns 204 No Content for a single document.

Input Parameters

array
required
List of documents to delete. Each object must contain a document id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CHANGE_DOCUMENT_OWNERSHIPChange document ownership. This operation allows transferring the ownership of a document to another user by specifying the document ID and membership ID.

Input Parameters

string
required
Specify document ID.
boolean
If set to true, disables the email and in-app notifications about the ownership transfer that are sent to the new document owner.
string
A unique identifier of a workspace member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CHANGE_DOCUMENT_STATUSChange document status. PandaDoc has eight document statuses, but you can manually set your document status to only four: ### Document statuses - Completed - document.completed - API code 2 - Expired - document.voided - code 11 - Paid - document.paid - code 10. Important: You can only set it if you have a payment app connected. - Declined - document.declined - code 12 > 🚧 Pass a numeric code for the corresponding document status, for example, 2 for document.completed. Find more details in [[Editor 2.0] Manually change document status](https://support.pandadoc.com/en/articles/9714842-manually-change-document-status) topic. | Current Status | To Completed: | To Expired: | To Paid: | To Declined: | |----------------|---------------|-------------|----------|--------------| | Draft | YES | NO | YES | YES | | Approved | NO | NO | NO | NO | | Se

Input Parameters

string
required
Specify document ID.
string
Provide “private notes” regarding the manual status change.
integer ("2" | "10" | "11" | "12")
required
Status.
boolean
Send a notification email about the status change to all recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CHANGE_DOCUMENT_STATUS_WITH_UPLOADManually change a document’s status with an optional file attachment. Supports completed (2), paid (10), expired (11), and declined (12). Allowed transitions depend on the current document status; paid requires a connected payment app. Setting notify_recipients sends email to recipients. Returns no content on success, not the updated document.

Input Parameters

string
required
ID of the document whose status will change.
object
JSON data part of the status-change multipart request.
object
Binary attachment file to upload with the status change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CHANGE_WORKSPACE_MEMBER_ROLEChange a workspace member role. Change the role of an existing workspace member. - You must be an organization admin, a workspace admin, or hold a role with permission to edit member roles to call this endpoint. - The role field accepts either a built-in role name (Admin, Manager, Member, Collaborator) or the name of a custom role defined for the workspace. - The role of the workspace owner cannot be changed. - The role of the last member with admin privileges in the workspace cannot be changed. - When a member with a Guest license is promoted to any non-Collaborator role, the user’s license is automatically upgraded to Full (Standard). If the organization has no free seats available, an additional seat is purchased.

Input Parameters

string ("Admin" | "Manager" | "Member" | "Collaborator")
required
Role.
string
required
Member id.
string
required
Workspace id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_CONTENT_LIBRARY_ITEMCreate a content library item. 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.

Input Parameters

string
Secure (HTTPS) and publicly accessible URL to the PDF document.
string
The name of the Content Library Item.
boolean
Only applicable when creating a content library item from a DOCX file. When true, the DOCX is converted into editable content, so the resulting content library item can be edited.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_CONTENT_LIBRARY_ITEM_FROM_UPLOADUpload a file to create a PandaDoc content library item asynchronously. The maximum upload size is 100 MB. Field tags and form fields are not supported. A successful upload does not mean processing is complete: check the item’s status until cli.PROCESSED or cli.ERROR. DOCX uploads support editable conversion. See POST /public/v1/content-library-items?upload (createContentLibraryItemFromUpload).

Input Parameters

object
required
File to upload, up to 100 MB.
string
Name of the content library item. Omitted when not provided.
boolean
For DOCX files only: convert the file into editable content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_DOCUMENT_ATTACHMENTCreates and adds an attachment to a PandaDoc document. This tool allows you to attach downloadable files such as supplemental materials, Excel spreadsheets, or other content without embedding them directly into the document. Attachments can be added only to documents in ‘document.draft’ status, with a maximum of 10 files per document and a size limit of 50MB per file.

Input Parameters

object
required
File to upload as an attachment.
string
required
UUID of the document to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_DOCUMENT_EDITING_SESSIONCreate a document editing session. Creates a new editing session for the Embedded Editor. The response includes an E-Token, which is required to open the document. > 🚧 Important: The Embedded Editor can only open documents that have a draft status. #### Limitations - Single Active Session per User-Document Pair Only one editing session can be active at a time for a specific user and document. Creating a new session for the same user-document pair will automatically invalidate the previous one. - Weekly Session Cap A maximum of 250 editing sessions can be created for a single document per week. Any attempt to exceed this limit will result in a 403 Forbidden error.

Input Parameters

string
required
Document ID
string
required
Email of the user to create the editing session for
integer
Lifetime of the E-Token in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_DOCUMENT_FIELDSCreate document fields. Creates fields for a particular document. For CFR11-compliant workspaces (21 CFR Part 11), signature fields must have a minimum size of 108×33.

Input Parameters

string
required
Document UUID.
array
An array of fields to place on a document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_DOCUMENT_FROM_FILECreates a new document in PandaDoc by uploading a file (PDF, DOCX, or RTF). Converts existing documents into PandaDoc documents for processing, signing, and tracking. Either file or url must be provided; omitting both will fail. Large files may time out during upload and conversion.

Input Parameters

string
Public HTTPS URL of the file to use (PDF, DOCX, or RTF format). Either ‘file’ or ‘url’ must be provided.
object
File to upload (PDF, DOCX, or RTF format). Either ‘file’ or ‘url’ must be provided.
string
required
Name of the document
array
Tags to categorize the document
object
Model for document owner.
array
required
List of recipients for the document Each recipient object must include a valid email field; missing or malformed emails will prevent sending or signing.
boolean
Whether to parse form fields in the document (for PDFs)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_DOCUMENT_SECTIONCreate a document section. With this endpoint, you can add a new section to an existing PandaDoc document (create a bundle). You can upload a section to the document using a PandaDoc template or a file by URL. > ⏱️ Document Section creation is a non-blocking (asynchronous) operation > > The document creation process may take some time. > > With a successful request, you receive a response with the created upload ID and status document_sections_upload.uploaded. After processing completes on our servers, usually a few seconds, the document moves to the document_sections_upload.PROCESSED status. ## Using a PandaDoc template <details> > 🚧 Current Version Limitations > > Images in sections are currently not supported. > 📘 Pricing tables note > > Each pricing table must have a unique name to populate it with data correctly. A PandaDoc template is a document template

Input Parameters

string
required
Request body as documented by PandaDoc.
string
required
Document ID
string ("document" | "upload")
Determines how the fields are mapped when creating a section. * document: Default value. The fields of the entire document are updated. * upload: Only the fields from the created section are updated. The merge field is appended with the upload ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_DOCUMENT_SECTION_FROM_UPLOADAdd a section to an existing version 2 document from a PDF, DOCX, or RTF. Uploads one file of at most 50 MB; encrypted PDFs are unsupported. Creation is asynchronous: poll Document Section Upload Status using the returned upload uuid until PROCESSED (or ERROR) before relying on the section being available. This uploads embedded document content, not a downloadable attachment.

Input Parameters

object
required
One PDF, DOCX, or RTF, up to 50 MB. Encrypted PDFs are unsupported.
string
Name of the section.
array
Section tags.
object
Fields keyed by optId, containing value, role, and optional options. Declare all form fields and roles; signatures cannot be prefilled.
array
Variables to prefill.
array
required
Section recipients, with email for individual recipients. Field tag roles must match these roles; underscores in field tag role names are unsupported.
string
required
ID of the existing version 2 document.
boolean
Detect field tags; provider default is true. False keeps tags as regular text.
string ("document" | "upload")
document (provider default) updates fields across the document; upload updates only new section fields and appends the upload ID to merge fields.
boolean
True for PDF form fields; false for field tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_EMBEDDED_SIGNING_SESSIONCreate an embedded signing session. Creates a document session for a recipient to view and sign a document. > 📘 How to create an Embedded Sign session > For more information on how to create an Embedded Sign session, see the Embedded Signing documentation.

Input Parameters

string
required
Document ID
number
The duration in seconds for which the document link will remain valid. The link will expire and become inaccessible after this time period. For security, we recommend setting the lifetime to less than one year (e.g., "lifetime": 31535999). If not specified, the default value is 1 hour (3600 seconds).
string
required
Email address of the person who will receive access to the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_FOLDERCreates a new folder in PandaDoc to organize documents. This action allows users to create a new folder with a specified name and optionally set a parent folder to create a nested folder structure.

Input Parameters

string
required
Name of the folder to be created
string
UUID of the parent folder if creating a nested folder structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_LINKED_OBJECTCreate a linked object. Create a linked object in the document. > 🚧 > > You can only link each document to each CRM once. This ensures the consistent functionality of the two-way CRM sync. > > You can, however, link one document to several external systems.

Input Parameters

string
required
Specify document ID.
string
required
CRM name (lowercase). See the list of available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
string
required
Entity unique identifier. The system validates if the entity exists.
string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_NOTARIZATION_REQUESTCreate a notarization request. Create a notarization request to connect with a notary and complete online notarizations for your signers within minutes. > 🚧 Important: This endpoint supports only documents in draft status. ## Prerequisites > 🚧 Before you start > > Ensure the following before creating a notarization request: > > - Install the Notary On-Demand or Notary add-on > - Create a document for notarization and get its document_id. To create a document, use the Create Document from Template or Create Document from File Upload endpoint. ## Request Details For the notarization request, include in the request body: - document_id - At least one invitees, specifying their email, first_name, and `last_na

Input Parameters

object
Optional notary assignment for in-house notary requests. Used for Bring you own notary use case. Only ACTIVE notaries can be used
object
required
Invitation.
string
required
ID of the Document for notarization.
boolean
Disable invitees notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_OR_UPDATE_CONTACTCreate a PandaDoc contact or attempt to update an existing contact by email. An update is attempted when creation reports that the contact already exists and an exact email match is found in the returned contacts.

Input Parameters

string
City of the contact
string
required
Email address of the contact. Required for both create and update operations.
string
Phone number of the contact
string
State of the contact
string
Company name of the contact
string
Country of the contact
string
Job title of the contact
string
Last name of the contact
string
First name of the contact
string
Postal code of the contact
string
Street address of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_PRODUCT_CATALOG_ITEMCreate a product catalog item. Create a new catalog item.

Input Parameters

string
Sku.
string ("regular" | "bundle")
Type.
string
required
Title.
array
Images.
string
Category id.
string
Description.
array
Bundle items.
array
Custom fields.
object
required
Price configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_TEMPLATEThis tool allows users to create a new template in PandaDoc from a PDF file or from scratch. It handles file upload validation, parameter checks, proper error handling, and authentication with the PandaDoc API. The template can be created either by uploading a PDF file or by providing a structured content object that defines the template layout and elements.

Input Parameters

object
PDF file to use for template creation
string
required
Name of the template
array
Optional tags to categorize the template
object
Content model for template creation from scratch.
string
Optional description of the template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_TEMPLATE_EDITING_SESSIONCreate a template editing session. Creates a new editing session for the Embedded Editor. The response includes an E-Token, which is required to open the template. #### Limitations - Single Active Session per User-Template Pair Only one editing session can be active at a time for a specific user and template. Creating a new session for the same user-template pair will automatically invalidate the previous one. - Weekly Session Cap A maximum of 250 editing sessions can be created for a single template per week. Any attempt to exceed this limit will result in a 403 Forbidden error.

Input Parameters

string
required
Template ID
string
required
Email of the user to create the editing session for
integer
Lifetime of the E-Token in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_TEMPLATE_FOLDERCreate a template folder. Create a new folder to store your templates. For the full list of folder operations and their limitations, see Organize Templates and Folders.

Input Parameters

string
required
Name the folder for Templates you are creating.
string
ID of the parent folder. To create a new folder in the root folder, remove this parameter in the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_USERCreate a user. 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. - We check that the user email and phone number have a valid format.

Input Parameters

object
required
User info
string ("Full" | "eSign" | "Read-only" | "Creator" | "Guest")
required
License.
array
required
Info for adding a user to a workspace(s)
boolean
Send a confirmation email to the user that was added to workspace(s).
boolean
Send a confirmation email to all workspace admins indicating that the user has been added to the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_WEBHOOKCreates a new webhook subscription in PandaDoc to receive notifications about specific events. This action allows you to set up webhook notifications for various document-related events such as status changes, recipient completions, and updates. The webhook will send HTTP notifications to your specified endpoint when the configured events occur.

Input Parameters

string
required
The endpoint URL where webhook notifications will be sent
string
required
A descriptive name for the webhook subscription
boolean
Whether the webhook subscription should be active
array
Additional data to include in webhook payload
array
required
List of events that will trigger the webhook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_CREATE_WORKSPACECreate a workspace. Create a workspace in your organization. - You need to be an Org Admin to create a workspace. - You will be added to the new workspace with an Admin role.

Input Parameters

string
required
A name for the new workspace.
string
Workspace icon will be displayed in the application and is not visible to your customers. Icon should have square proportions. Supported formats: JPEG, PNG, GIF, WEBP. Max size: 5 MB
object
Optional workspace settings applied at creation time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DEACTIVATE_WORKSPACEDeactivate a workspace. Deactivate the workspace, remove all the members from it and make it unavailable.

Input Parameters

string
required
Workspace id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_CONTACTThis tool allows you to delete a contact from your PandaDoc account. The action is permanent and cannot be undone.

Input Parameters

string
required
The unique identifier of the contact to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_DOCUMENTDelete a document. Delete a document by ID.

Input Parameters

string
required
Document ID
boolean
Set to false to soft-delete the document (move it to the Trash Bin, where it can be restored) instead of deleting it permanently. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_DOCUMENT_ATTACHMENTDelete a document attachment. Deletes an attachment from the document.

Input Parameters

string
required
Document UUID.
string
required
Attachment UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_DOCUMENT_RECIPIENTDelete a document recipient. Remove a recipient from a document. > 🚧 Before you start > > Please ensure that you have the ‘Can Manage Recipients’ permission. To remove a recipient from a document, you must specify their ID in the path parameter (note that this is different from their contact’s ID). The recipient’s ID can be retrieved via the Document Details endpoint. ### Document status - Removing a signer is only possible when the document is in the ‘Draft’ (document.draft) status and this action will unassign all fields associated with that signer. - Removing a CC recipient is allowed in any document status except for the ‘Expired’ (document.voided) and ‘Declined’ (document.declined). If a CC recipient is removed, their access will be revoked.

Input Parameters

string
required
Document UUID
string
required
Recipient UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_DOCUMENT_SECTIONDelete a document section. Removes selected section from the document.

Input Parameters

string
required
Specify section ID.
string
required
Specify document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_LINKED_OBJECTDelete a linked object. Delete a linked object associated with a document.

Input Parameters

string
required
Specify document ID.
string
required
Specify linked object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_NOTARIZATION_REQUESTDelete a notarization request. Use this method to delete a notarization request. Once notarization request is deleted it cannot be restored. > 🚧 Notarization Request status > > You can only delete a notarization request in status ‘SENT’, ‘WAITING_FOR_NOTARY’ or ‘INCOMPLETE’. > If the notarization request is in any other status, the request will return a 400 Bad Request error. By default all invitees will receive email notification about deletion of the notarization request. If you want to disable this notification, you can use the disable_invitees_notifications parameter when creating request (see Create Notarization Request).

Input Parameters

string
required
Notarization Request ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_PRODUCT_CATALOG_ITEMDelete a product catalog item. Delete catalog item.

Input Parameters

string
required
Catalog item UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_TEMPLATEThis tool deletes a specific template from PandaDoc. Once a template is deleted, it cannot be recovered. This action is permanent and should be used with caution.

Input Parameters

string
required
The unique identifier of the template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DELETE_WEBHOOK_SUBSCRIPTIONDelete a webhook subscription. This operation deletes a specific webhook subscription identified by its UUID.

Input Parameters

string
required
Webhook subscription uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DOWNLOAD_COMPLETED_DOCUMENTDownload a completed document. Download a completed document as a verifiable PDF (Download Protected Document) > 🚧 Production key only > > This endpoint only works with a Production key. You’ll get a 401 Unauthorized error when trying to use a Sandbox key. Download a signed PDF of a completed document

Input Parameters

string
required
Specify document ID.
boolean
Download document bundle as a zip-archive of separate PDFs (1 file per section).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DOWNLOAD_DOCUMENTDownload a PandaDoc document as PDF, or a bundle as separate PDFs in a ZIP. For completed and signed documents, use PandaDoc’s Download Protected Document endpoint instead. If the file is still being generated, retry after the delay reported in the error. Redirects are not followed to protect credentials.

Input Parameters

string
required
The ID of the document to download.
boolean
Download a document bundle as a ZIP of separate PDFs, one per section.
string
Watermark text.
string
Watermark HEX color, for example #FF5733.
number
Watermark opacity from 0.0 to 1.0.
integer
Font size of the watermark.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DOWNLOAD_DOCUMENT_ATTACHMENTDownload a document attachment. Download an attachment by ID.

Input Parameters

string
required
Document UUID.
string
required
Attachment UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_DUPLICATE_TEMPLATEDuplicate a template. ## Duplicate Template Creates a copy of a template within the same workspace. > 📘 Permissions > > Requires can_read_templates and can_duplicate_templates permissions. Duplicating templates owned by other users additionally requires can_duplicate_any_template.

Input Parameters

string
required
Template ID
string
Custom name for the duplicated template. When omitted or empty, a name is auto-generated from the source template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_API_LOG_DETAILSGet API log details. Returns details of the specific API log event.

Input Parameters

string
required
Log event id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_ATTACHMENT_DETAILSGet attachment details. Returns details of the specific document’s attachment.

Input Parameters

string
required
Document UUID.
string
required
Attachment UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_AUTOMATIC_REMINDER_SETTINGSGet automatic reminder settings. Retrieves the current auto reminder configuration for a specified document.

Input Parameters

string
required
The UUID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_AUTOMATIC_REMINDER_STATUSGet automatic reminder status. Retrieves the current auto reminder status per recipient for a specified document. Recipients who could not receive reminders due to validations (recipient groups, non-signers, etc.) will be skipped and not included in the response.

Input Parameters

string
required
The UUID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_CONTACT_DETAILSGet contact details. Returns contact details by its ID.

Input Parameters

string
required
Contact id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_CONTENT_LIBRARY_ITEM_DETAILSGet content library item details. Retrieve detailed information about a specific content library item using its ID. The details include: - Roles - All fields with values - All tokens with values - Pricing information (pricing tables, products, etc) - Metadata - Tags - Modification Timestamps: note that date_modified means any changes associated with the CLI, while content_date_modified logs any changes in CLI content.

Input Parameters

string
required
Content Library Item ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_CONTENT_LIBRARY_ITEM_STATUSGet content library item status. Requesting the CLI status helps verify that a CLI is in the expected state before invoking additional API methods. ## Available CLI Statuses The following is a complete list of all possible CLI statuses returned: | CLI Status | Status Description | |-----------------|--------------------| | cli.UPLOADED | The CLI upload process has been initiated and is currently in progress. It will soon transition to the cli.PROCESSED state. | | cli.PROCESSED | The CLI has been successfully uploaded and created. At this stage, all aspects of the CLI are editable. | | cli.ERROR | The CLI upload process has failed. Please refer to the error details in the response for more information. |

Input Parameters

string
required
Content Library Item ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_CURRENT_MEMBERGet the current member. Returns the member details of the current user (the owner of the API key). User - is an account with a license in the Organization. Member - is a User with a predefined Role in the Workspace. | Parameter | Description | |---|---| | user_id | A unique identifier of the user in the organization | | membership_id | A unique identifier of the user in the workspace | | email | A user email address | | first_name | A user’s first name | | last_name | A user’s last name | | is_active | A boolean value that identifies if a member is active and not blocked | | workspace | A unique identifier of the user’s current active workspace | | workspace_name | A name of the user’s current active workspace | | email_verified | A boolean value that identifies if the email is verified | | role | A member’s role in the wo

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_DOCUMENT_DETAILSFetch detailed metadata for a specific PandaDoc document including recipients, fields/tokens values, pricing data, metadata, tags, and content-block names. Use this after discovering a document via list/search to inspect recipients/status/fields/metadata/content-block references for follow-up automation or reporting.

Input Parameters

string
required
The unique identifier of the document to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_DOCUMENT_E_SIGN_DISCLOSUREGet the document eSign disclosure. Retrieves the current version of eSign disclosure text for a specified document.

Input Parameters

string
required
The UUID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_DOCUMENT_SECTION_DETAILSGet document section details. Receive information about each section.

Input Parameters

string
required
Section ID.
string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_DOCUMENT_SETTINGSGet document settings. Retrieves the settings for a specified document.

Input Parameters

string
required
Unique identifier of the document to retrieve settings for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_DOCUMENT_STATUSGet document status. It is useful to request document status to ensure a document is in the expected state before calling additional API methods. ### Required Document Statuses Here are some common methods and the document.status required to proceed: | API Method | Required Document State | | :------------------- | :---------------------- | | Send A Document | document.draft | | Get Document Details | document.draft | | Embed A Document | document.sent | | Download A Document | document.completed | > 📘 Polling vs Webhooks > > If you are using the GET document status endpoint for polling, we also support and recommend using webhooks for event-driven needs: <https://developers.pandadoc.com/docs/listen-document-status-changes#/> ### Available Document Statuses The following is a comp

Input Parameters

string
required
Specify document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_MEMBER_DETAILSGet member details. A method to retrieve a member’s details by ID. User - is an account with a license in the Organization. Member - is a User with a predefined Role in the Workspace. | Parameter | Description | |---|---| | user_id | A unique identifier of the user in the organization | | membership_id | A unique identifier of the user in the workspace | | email | A user email address | | first_name | A user’s first name | | last_name | A user’s last name | | is_active | A boolean value that identifies if a member is active and not blocked | | workspace | A unique identifier of the user’s current active workspace | | workspace_name | A name of the user’s current active workspace | | email_verified | A boolean value that identifies if the email is verified | | role | A member’s role in the workspace | | user_license |

Input Parameters

string
required
Membership id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_NOTARIZATION_REQUEST_DETAILSGet notarization request details. Get details about a notarization request by its id. Details include: - Basic notarization request information (status, creator, invitees). - Signed documents information with links for downloading. - Notarization session recording information with link for downloading. - Timestamps associated with a notarization request. - Termination reason and details when the notarization session was not completed successfully. ## Available Notarization Request Statuses The following is a complete list of all possible notarization request statuses returned: | Notarization Request Status | Status Description | | :-------------------------- | :----------------------------------------------------------------------------------------------------------------- | | SENT | Notarization request has been created. Invitees are notified and can start the process

Input Parameters

string
required
Notarization Request ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_PRODUCT_CATALOG_ITEMGet a product catalog item. Get catalog item.

Input Parameters

string
required
Catalog item UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_SECTION_UPLOAD_STATUSGet section upload status. Receive the upload status of the document and sections by their upload_id. Requesting document section upload status is useful to ensure a document section upload is in the expected state before calling additional API methods. In response, you receive an array with sections_uuid. You can receive information about each section using the Document Section Info endpoint. json "section_uuids": [ "H8T8CJofGY6JwTsWsPuDEF", "8MwLaU4SaZywqLiDk26mDF" ] ## Available Document Section Upload Statuses The following is a complete list of all possible document statuses returned: | Document Status | Status Description | | :----------------------------------- | :-----------------------------------------------------------------------------------------------------------------------

Input Parameters

string
required
Upload ID.
string
required
Document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_TEMPLATE_DETAILSRetrieve details for a specific PandaDoc template by ID, including metadata, roles, fields, tokens and pricing information when available.

Input Parameters

string
required
The unique identifier of the template to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_TEMPLATE_SETTINGSGet template settings. Retrieves the settings for a specified template. Only the language field is currently supported.

Input Parameters

string
required
Unique identifier of the template to retrieve settings for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_TEMPLATE_SHARING_SETTINGSGet template sharing settings. Retrieves template sharing settings.

Input Parameters

string
required
Unique identifier of the Template to retrieve Shares for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_TEMPLATE_STATUSGet template status. ## Available Template Statuses The following is a complete list of all possible template statuses returned: | Template Status | Status Description | | :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | | template.UPLOADED | The template upload process has been initiated and is currently in progress. It will soon transition to the template.PROCESSED state. | | template.PROCESSED | The template has been successfully uploaded and created. At this stage, all aspects of the template are editable. | | template.ERROR | The template upload process has failed. Please refer to the error details in the response for more information. |

Input Parameters

string
required
Template ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_USER_BY_IDGet a user by ID. 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.

Input Parameters

string
required
A unique identifier of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_WEBHOOK_EVENT_DETAILSGet webhook event details. This operation fetches detailed information about a specific webhook event using its unique identifier.

Input Parameters

string
required
Webhook event uuid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_GET_WEBHOOK_SUBSCRIPTION_DETAILSGet webhook subscription details. Get webhook subscription by uuid

Input Parameters

string
required
Webhook subscription uuid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_API_LOGSList API logs. Get the list of all logs within the selected workspace. Optionally filter by date, page, and # of items per page.

Input Parameters

string
Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as “-10d” (for past 10 days) or a special “now” value.
integer
Returns page of the results by number. The total number of accessible items (count × page) must not exceed 10,000.
integer
The amount of items on each page. The total number of accessible items (count × page) must not exceed 10,000.
string
Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as “-90d” (for past 90 days).
Returns the results containing a string.
array
Returns only the predefined HTTP methods. Allows GET, POST, PUT, PATCH, and DELETE.
array
Returns only the predefined status codes.
string ("PRODUCTION" | "SANDBOX")
Returns logs for production/sandbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_CONTACTSList PandaDoc workspace contacts, optionally filtering by email address. Returned contact details include email, name and company.

Input Parameters

string
Filter contacts by exact email match. Returns only contacts with this specific email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_CONTENT_LIBRARY_ITEMSList content library items. The endpoint retrieves items from the content library in PandaDoc. This endpoint supports filtering options to narrow down the results, allowing users to search by query, tags, folder, and more. > ### ⚠️ Please avoid empty values for the parameters > API returns “400” error when any of the parameters has an empty value. Please remove such a parameter from the request or add a value.

Input Parameters

string
Search query. Filter by content library item name.
string
Specify content library item ID.
string
Search tag. Filter by content library item tag.
integer
Specify which page of the dataset to return.
integer
Specify how many content library items to return. Default is 50 content library items, maximum is 100 content library items.
boolean
Returns only the deleted content library items.
string
The UUID of the folder where the content library items are stored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENT_ATTACHMENTSList document attachments. Returns a list of attachments associated with a specified document.

Input Parameters

string
required
Document UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENT_AUDIT_TRAILList document audit trail. Retrieves the full audit trail for a specified document. The audit trail includes detailed user actions such as sending, viewing, signing, and editing, along with metadata like timestamps, IP addresses, and user identity. This endpoint is accessible to authorized workspace administrators only.

Input Parameters

integer
Maximum number of items to return.
integer
Number of items to skip before starting to collect the result set.
string
required
Unique identifier of the document to retrieve the audit trail for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENT_FIELDSList document fields. Return the list of fields for a particular document.

Input Parameters

string
required
Document UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENT_FOLDERSList PandaDoc document folders, optionally specifying a parent folder and pagination. Folder results include IDs, names and parent relationships when available.

Input Parameters

integer
Page number (starts from 1)
integer
Number of folders to return (default: 50, max: 100)
string
The UUID of the parent folder. If omitted, returns folders in root directory

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENTSList and search PandaDoc documents with filters, pagination, and ordering.

Input Parameters

string
Filter by document ID
string
Filter documents by tag
integer
Page number of the results to return
integer
Maximum number of documents to return per page (1-100)
string
Filter documents by name or reference number
integer ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14")
Filter by PandaDoc document status code
boolean
Whether to return only deleted documents
string
Filter by parent form ID; cannot be combined with template_id
object
Filter by metadata using raw metadata keys and string values. Each entry is sent as metadata_<key>=<value>; for example, {‘opportunity_id’: ‘2181432’} sends metadata_opportunity_id=2181432.
string ("name" | "date_created" | "date_status_changed" | "date_of_last_action" | "date_modified" | "date_sent" | "date_completed" | "date_expiration" | "date_declined" | "status" | "-name" | "-date_created" | "-date_status_changed" | "-date_of_last_action" | "-date_modified" | "-date_sent" | "-date_completed" | "-date_expiration" | "-date_declined" | "-status")
Document field and direction to order by
string
Filter by recipient or approver contact ID
string
Return documents created before this date-time
integer ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12" | "13" | "14")
Exclude this PandaDoc document status code
string
Filter by the folder containing the documents
string
Return documents modified before this date-time
string
Filter by parent template ID; cannot be combined with form_id
string
Return documents completed before this date-time
string
Return documents created at or after this date-time
string
Filter by the document owner’s membership ID
string
Return documents modified at or after this date-time
string
Return documents completed at or after this date-time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENTS_BY_LINKED_OBJECTList documents by linked object. Get a list of documents connected to a linked object - an entity from an integration.

Input Parameters

string
Order by.
string
required
You can get entity id from your integration, for example, from a url of a HubSpot deal.
array
Owner ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_DOCUMENT_SECTIONSList document sections. Retrieve information about the sections within a document.

Input Parameters

string
required
Document ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_FORMSList forms. Retrieve a paginated list of forms with optional filtering and sorting options.

Input Parameters

boolean
Specify sorting the result-set in ascending or descending order.
string
Specify the form name.
integer
Specify which page of the dataset to return.
integer
Specify how many forms to return. Default is 50 forms, maximum is 100 forms.
array
Specify which status of the forms dataset to return.
string ("name" | "responses" | "status" | "created_date" | "modified_date")
Specify the form dataset order to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_LINKED_OBJECTSList linked objects. Get a list of linked objects for the document.

Input Parameters

string
required
Specify document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_NOTARIESList notaries. Retrieve a list of notaries associated with your organization. ## Important Notes - At the moment, notaries can be added to organization only manually through the PandaDoc Notary UI. - Organization must have Notary addon enabled to use this endpoint

Input Parameters

integer
Maximum number of results to return
integer
Number of results to skip
array
Filter by status (comma-separated values supported). Valid values are INVITED, UNDER_REVIEW, ACTIVE, REJECTED, INACTIVE
string ("email" | "-email" | "status" | "-status" | "name" | "-name")
Sort by name, email, or status (default is email). Use a - prefix for descending order (e.g., -email)
array
Filter by commission state (comma-separated values supported)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_NOTARIZATION_REQUESTSList notarization requests. Retrieve a paginated list of notarization requests for your organization. Results can be filtered by status, creator, or document, and sorted by status or by the request’s creation or completion dates. ## Permissions > 🔒 Requirements > > - The Notary On-Demand or Notary add-on must be enabled for your organization. Without an active add-on, the endpoint returns 403 Forbidden. > - The request is executed with the permissions of the API key owner. By default, the response only includes notarization requests created by the API key owner. To list notarization requests created by any user in the organization, the API key owner must have the Can view any notarization request permission. ## Limits A maximum of 100 API calls per minute is permitted. Exceeding this limit triggers a 429 Too Many Requests error.

Input Parameters

integer
Maximum number of results to return.
integer
Number of results to skip.
array
Filter by status (comma-separated values supported).
string ("status" | "-status" | "date_created" | "-date_created" | "date_completed" | "-date_completed")
Sort field. Use a - prefix for descending order (e.g., -date_created). When omitted, results are sorted by date_created ascending (oldest first).
array
Filter by document ID (comma-separated values supported).
array
Filter by creator user ID (comma-separated values supported).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_RECENT_SMS_OPT_OUTSList recent SMS opt-outs. Retrieves a list of the most recent SMS opt-out changes for each phone numbers used in your workspace. > 📘 You can filter results by time range using timestamp_from and timestamp_to.

Input Parameters

string
The end of the timestamp range. If no timestamp is provided the current time will be used.
string
The start of the timestamp. If no timestamp is provided, 1 hour before the current time will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_TEMPLATE_FOLDERSList template folders. Get the list of folders that contain Templates in your account. > 📘 > > The root folder is not listed in the response. For the full list of folder operations and their limitations, see Organize Templates and Folders.

Input Parameters

integer
Optionally, specify which page of the dataset to return.
integer
Optionally, specify how many folders to return.
string
The UUID of the folder containing folders. To list the folders located in the root folder, remove this parameter in the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_TEMPLATESThis tool retrieves a list of all templates available in the PandaDoc account. It supports parameters to filter templates by name, shared status, deleted status, pagination, and tag filtering, and returns detailed template information.

Input Parameters

string
Search query to filter templates by name
string
Specific template ID to retrieve
array
Filter templates by tags
integer
Page number of the results to return
integer
Number of templates to return per page (1-100, default: 50)
array
Additional fields to include in the response (e.g., content_date_modified)
boolean
If true, returns only shared templates
boolean
If true, returns only deleted templates
string
UUID of the folder where the templates are stored

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_USERSList users. Get a list of all users with membership in your organization, with their contact information, license type, and workspace roles. You must be an organization admin to list users.

Input Parameters

integer
Page number.
integer
Number of elements in page.
boolean
Filter option - show users with removed memberships.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_WEBHOOK_EVENTSList webhook events. This operation retrieves a paginated list of all webhook events.

Input Parameters

string
Return results where the event creation time is less than this value.
integer
required
Specify which page of the dataset to return.
array
Returns results by the specified event types.
integer
required
Specify how many event results to return.
array
Returns results with the following errors.
string
Return results where the event creation time is greater than or equal to this value.
array
Returns results with the specified HTTP status codes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_WEBHOOK_SUBSCRIPTIONSList webhook subscriptions. This operation fetches a paginated list of webhook subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_WORKSPACE_MEMBERSList workspace members. Retrieve all members details of the workspace implied by the OAuth token or API key. For each member, the workspace parameter shows their active workspace, that is the workspace they are currently working in. This means the workspace value can differ from the workspace implied by your API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_LIST_WORKSPACESList workspaces. Get a list of all the active workspaces in the organization.

Input Parameters

string
Filters workspaces by name (case-insensitive).
integer
Page number.
integer
Number of elements in page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_MOVE_DOCUMENT_TO_DRAFTMove a document to draft. Revert your document back to draft to continue editing it. > 📘 Returning to Draft works for any document status except Removed. ## After you move your document to the Draft status - Signature and Initials fields are cleared. All other fields stay filled in. - Recipients are not notified that the document is back in Draft. - You’ll need to resend the document so that recipients can sign the updated version.

Input Parameters

string
required
Specify document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_MOVE_DOCUMENT_TO_FOLDERThis tool allows users to move a document to a specific folder within their PandaDoc account. It performs a POST request to move the document to the specified folder. Both the document and the destination folder must exist. Only documents in draft status can be moved; attempting to move documents in sent, completed, or other non-draft states will fail.

Input Parameters

string
required
The unique identifier of the destination folder
string
required
The unique identifier of the document to move

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_REASSIGN_DOCUMENT_SIGNERReassign a document signer. Reassign fields to another signer. > 🚧 Before you start > > To change a signer in a document, please ensure that: > > - You have the ‘Can Manage Recipients’ permission. > - New signer is already created in your contacts. If not, add them using the Create Contact endpoint. You can reassign fields to another signer before the original signer has signed the document. You can choose any person except those recipients who have already signed the document. The endpoint path includes the recipient_id of the original signer and the request body must include the following two parameters: - kind: Set this parameter to contact to specify an individual contact, or contact_group to specify a contact group. - id: Input the ID of the contact (for kind: contact) or contact group (for

Input Parameters

string
required
Document UUID
object
required
Request body as documented by PandaDoc.
string
required
Recipient UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_REMOVE_WORKSPACE_MEMBERRemove a workspace member. This operation removes a specified member from a workspace by providing the workspace ID and member ID.

Input Parameters

string
required
Member id
string
required
Workspace id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_RENAME_DOCUMENT_FOLDERRename a document folder. Rename Documents Folder. For the full list of folder operations and their limitations, see Organize Documents and Folders.

Input Parameters

string
required
The UUID of the folder that you are renaming.
string
required
Provide a new name for the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_RENAME_TEMPLATE_FOLDERRename a template folder. Rename a templates folder. For the full list of folder operations and their limitations, see Organize Templates and Folders.

Input Parameters

string
required
The UUID of the folder which you are renaming.
string
required
Provide a new name for the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_SEARCH_CATALOG_ITEMSSearch PandaDoc product catalog items with filters and ordering.

Input Parameters

number
Page number
string
Search title, SKU, description, category name, and custom fields
array
Catalog item types to include
string ("sku" | "-sku" | "title" | "-title" | "price" | "-price" | "date_modified" | "-date_modified")
Property and direction used to order results
number
Number of catalog items to return per page
string
Return items from this category ID
boolean
Return only items without a category
array
Billing types to include
array
Catalog item UUIDs to exclude

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_SEARCH_PRODUCT_CATALOG_ITEMSSearch product catalog items. This method searches for items in your product catalog. Use the query parameter to search in title, SKU, description, category name, custom fields name and value. You can also search for items by their type, billing type, and category id. Order search results, in both ascending and descending order, by these item properties: - SKU - Name - Price - Modification date Use the exclude_uuids parameter to exclude particular uuids from the search request.

Input Parameters

number
Page number.
string
Search query. Searches the following fields: Title, SKU, description, category name, custom fields name and value.
array
Filter by catalog item types.
string ("sku" | "-sku" | "title" | "-title" | "price" | "-price" | "date_modified" | "-date_modified")
Ordering principle for displaying search results.
number
Items per page.
string
Category id.
boolean
No category.
array
Filter by billing types.
array
A list of item uuids to be excluded from search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_SEND_DOCUMENTSend a document. > 🚧 Using the Sandbox Key > > When you use a sandbox API key during the free trial period, the sender and recipient email addresses must be from the same organisation (email domain). ## Document State - You can only send a document in the document.draft status. - After creating a new document, it usually retains a document.uploaded status for 3-5 seconds while the document syncs across PandaDoc servers. When the document is available for further API calls, it moves to the document.draft state. Use Document Status or Webhooks to check document status. - Moving a document to the document.sent status finalizes the document structure, before recipients can complete it. - If a template used for the document cre

Input Parameters

string
required
Document ID
object
You can set a sender of a document as an email or membership_id
boolean
If set to true, disables email notifications for document recipients and the document sender. Also disables scheduled reminders (manual reminders still possible). Doesn’t affect “Approve document” email notification sent to the Approver.
string
A message that will be sent by email with a link to a document to sign.
string
Value that will be used as the email subject.
string
Email address that will be used as a reply-to address for the document. To use this parameter, please contact the support team to have it enabled for your account.
object
Configuration for selected approvers.
object
Set settings for Document and Signature forwarding.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_SEND_MANUAL_REMINDERSend a manual reminder. Sends manual reminders to one or more recipients of a specified document.

Input Parameters

array
required
A list of reminders to be sent to specified recipients. Use this field to specify which recipients should receive a reminder and through which delivery methods. Each email reminder contains document sender in the From field, ensuring the recipient always sees consistent sender details and branding.
string
required
The UUID of the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_TRANSFER_OWNERSHIP_OF_DOCUMENTSTransfer ownership of all documents. This method transfers ownership of all documents from one member to another.

Input Parameters

boolean
If set to true, disables the email and in-app notifications about the ownership transfer that are sent to the new documents owner.
string
A unique identifier of a workspace member to whom you want to transfer ownership.
string
A unique identifier of a workspace member from whom you want to transfer ownership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_AUTOMATIC_REMINDER_SETTINGSUpdate automatic reminder settings. Configures automatic reminders for document recipients. These reminders are sent after the document’s initial dispatch. Settings include enabling reminders, delivery method (email/SMS), initial delay, and recurrence frequency.

Input Parameters

boolean
required
Toggles auto-reminders for the document. If true, reminders are scheduled based on the configuration.
string
required
The UUID of the document.
boolean
If true, reminders will be sent repeatedly at specified intervals after the initial reminder.
string ("email" | "sms")
The method used to deliver reminders (e.g., email, SMS).
integer
Number of days to wait after sending the document before the first reminder is sent.
integer
Number of days between recurring reminders, applicable if is_recurring is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_DOCUMENTUpdate a document. Use the PATCH method to update a PandaDoc document. > 🚧 Document status > > You can only update a document in the Draft status (document.draft). > > After creating a new document, it usually retains a document.uploaded status for 3-5 seconds while the document syncs across PandaDoc servers. When the document is available for further API calls, the document moves to the document.draft state. Use Document Status or Webhooks to check document status.

Input Parameters

string
required
Document ID
string
The name of the document.
array
Mark your document with one or several tags.
array
You can pass a list of texts to text blocks for replacement.
object
Fields.
array
You can pass a list of images to image blocks (one image in one block) for replacement.
array
Tables.
array
Create or initialize multiple variables with their values using tokens/values list.
object
You can pass arbitrary data in the key-value format to associate custom information with a document. This information is returned in any API requests for the document details by id. If metadata exists in a document then the value will be updated. Otherwise, metadata will be added to the document.
array
The list of recipients you’re sending the document to. The ID or email are required. If the ID is passed, an existing recipient will be updated. If the email is passed, a new recipient will be added to CC.
array
Pricing tables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_DOCUMENT_FIELD_ASSIGNMENTSUpdate document field assignments. Assign, reassign, or unassign document fields to recipients. Supports bulk operations by accepting multiple field assignment items in a single request. > 🚧 Before you start > > - The document must be in the ‘Draft’ (document.draft) status. > - You must have the ‘Can Edit Document’ permission.

Input Parameters

string
required
Document UUID.
array
required
An array of field assignment operations. Each item specifies a field and the recipient it should be assigned to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_DOCUMENT_QUOTEUpdate a document quote. This operation updates the details of a specific quote within a document by specifying the document ID and quote ID. > 📘 Permissions > > Requires the ‘Can Edit Document’ and ‘Can Edit Content’ permissions. > The document must be in Draft (document.draft). > Updating quotes is available on plans that include > Product Catalog. > 🚧 Payload size > > The maximum request body size is 512 KiB (524288 bytes). Larger requests return 413 and are not applied.

Input Parameters

object
Summary.
string
Currency code (ISO 4217)
string
required
Quote ID
array
Quote sections - this property overrides existing sections in the specified order. If you want to change only one section, you must still pass other sections IDs. Otherwise these sections will be removed.
object
Quote settings. Denotes whether a quote is optional or selected, and selection type inside the section - single, multiple, or custom.
string
required
Document ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_DOCUMENT_RECIPIENTUpdate a document recipient. Modify a recipient’s personal details, or update a recipient group’s name and members. > 🚧 Before you start > > To edit a recipient, please ensure that you have the ‘Can Edit Document’ permission. Use this endpoint to easily fix typos in a recipient’s name or email, or to change any other recipient information in a sent document. ### Editing a recipient group When the recipient_id points to a recipient group, you can rename the group and/or change its members: - Send name to rename the group. - Send members to replace the group’s membership. The list you send becomes the group’s new full membership: members you omit are removed, and new entries are added. Members are matched by email; for a retained member, only the contact fields you include (first_name, last_name) are updated, and omitted fields keep their existing values. -

Input Parameters

string
required
Document UUID.
string
required
Request body as documented by PandaDoc.
string
required
Recipient UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_DOCUMENT_SETTINGSUpdate document settings. Updates the settings for a specified document.

Input Parameters

string ("en-US" | "fr-FR" | "it-IT" | "es-ES" | "nl-NL" | "de-DE" | "pt-BR" | "pt-PT" | "pl-PL" | "sv-SE" | "cs-CZ" | "da-DK" | "el-GR" | "hu-HU" | "nb-NO" | "ro-RO" | "bg-BG")
Document language code (e.g., ‘en-US’, ‘fr-FR’).
integer
Document expiration in days. Minimum is 1 day.
string
required
Unique identifier of the document to update settings for.
boolean
Enables or disables Suggest Edits (redlining) for the document. When true, recipients can suggest edits to the document content. Can only be changed while the document is in draft status.
boolean
Indicates whether the document requires a Qualified Electronic Signature (QES) during the signing process. If true, signers must complete the document using a third-party qualified electronic signature provider according to supported verification rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_PRODUCT_CATALOG_ITEMUpdate a product catalog item. Update catalog item.

Input Parameters

string ("regular" | "bundle")
Type.
string
Title.
string
required
Catalog item UUID
string
Category id.
array
Bundle items.
object
Product variant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_TEMPLATEUpdate a template. Update a template. Currently supports updating template variables (tokens) and managing template roles. > 🚧 Template status > > You can only update a template in the PROCESSED status (template.PROCESSED). > > After creating a new template, it usually retains a template.uploaded status for 3-5 seconds while the template syncs across PandaDoc servers. When the template is available for further API calls, the template moves to the template.PROCESSED state. Use Template Status or Webhooks to check template status. ## Managing template roles Pass a roles array to replace the full set of template roles in a single request: - Items with an existing id update that role (name, signing_order). - Items without an id create a new role. - Existing roles whose id is not in

Input Parameters

string
required
Template ID
array
Replace the full set of template roles. Items with an existing id are updated, items without an id are created as new roles, and existing roles whose id is not present in the list are deleted.
array
Create or initialize multiple CUSTOM variables with their values using tokens/values list. Template’s predefined variables are read-only. Any attempts to do so will be ignored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_TEMPLATE_SETTINGSUpdate template settings. Updates the settings for a specified template. Only the language field is currently supported.

Input Parameters

string ("en-US" | "fr-FR" | "it-IT" | "es-ES" | "nl-NL" | "de-DE" | "pt-BR" | "pt-PT" | "pl-PL" | "sv-SE" | "cs-CZ" | "da-DK" | "el-GR" | "hu-HU" | "nb-NO" | "ro-RO" | "bg-BG")
Document language code (e.g., ‘en-US’, ‘fr-FR’).
string
required
Unique identifier of the template to update settings for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_TEMPLATE_SHARING_SETTINGSUpdate template sharing settings. Replaces the full list of Workspaces this Template is shared with. The caller must be a member of every Workspace being newly shared by this call. Unsharing a Workspace only requires permission to edit the Template.

Input Parameters

string
required
Unique identifier of the Template whose Shares are being replaced.
array
required
Unique identifiers of the Workspaces the Template should be shared with, representing the complete desired end-state rather than a delta. Duplicate ids are deduplicated, and the server replaces the prior shares with this set atomically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PANDADOC_UPDATE_WEBHOOK_SUBSCRIPTIONUpdate a webhook subscription. This operation updates the details of a webhook subscription.

Input Parameters

string
required
Webhook subscription uuid
string
Set the new Webhooks subscription URL.
string
Set a new name for the Webhooks subscription.
boolean
Set the status of the Webhooks subscription.
array
Payload.
array
Triggers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not