The PandaDoc connector lets your AI agent act in each user's PandaDoc account. Each user signs in to PandaDoc once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 91 tools.
- Tools
- 91
- What they doRead · write · destructive
- 44 · 38 · 944 read38 write9 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own PandaDoc app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the PandaDoc connection
In AgentKit > Connections, create a PandaDoc connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
PandaDoc connections use your own OAuth app. Register one with PandaDoc and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the PandaDoc connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'pandadoc'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize PandaDoc:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'pandadoc_catalog_items_search',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "pandadoc"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize PandaDoc:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="pandadoc_catalog_items_search",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpandadoc_catalog_item_getGet the details of a single product catalog item by its UUID, including title, pricing configuration, variants, category, and bundle items (if any).Read-onlyCatalog Item Details
Get the details of a single product catalog item by its UUID, including title, pricing configuration, variants, category, and bundle items (if any).
Inputs
item_uuidstringrequired- The UUID of the catalog item to retrieve.
pandadoc_catalog_items_searchSearch for items in your product catalog.Read-onlyList Catalog Items Search
Search for items in your product catalog. The query parameter searches title, SKU, description, category name, and custom field names/values. Supports filtering by item type, billing type, category, excluded UUIDs, and sorting by SKU, name, price, or modification date. Returns a paginated list of catalog items with pricing, images, and tier information.
Inputs
billing_typesstring- Comma-separated list of billing types to filter by. Valid values: one_time, recurring.
category_idstring- Filter items belonging to this category id.
exclude_uuidsstring- Comma-separated list of item UUIDs to exclude from the search results.
no_categoryboolean- If true, return only items that do not belong to any category.
order_bystring- Sort order for results.one of
sku-skutitle-titleprice-pricedate_modified-date_modified pageinteger- Page number of results to fetch.default
1 per_pageinteger- Number of items to return per page.default
10 querystring- Search query matched against title, SKU, description, category name, and custom field names/values.
typesstring- Comma-separated list of catalog item types to filter by. Valid values: regular, bundle.
pandadoc_contact_getRetrieve the details of a single PandaDoc contact by its id.Read-onlyContact Details
Retrieve the details of a single PandaDoc contact by its id. Returns the contact object including email, name, company, job title, phone, and address fields.
Inputs
idstringrequired- The unique identifier of the contact to retrieve.
pandadoc_contacts_listList contacts associated with your PandaDoc workspace.Read-onlyList Contacts
List contacts associated with your PandaDoc workspace. Optionally filter by an exact email address match. Returns an array of contact objects (id, email, first_name, last_name, company, job_title, phone, country, state, street_address, city, postal_code).
Inputs
emailstring- Filter contacts by an exact email address match. Leave blank to list all contacts.
pandadoc_content_library_item_get_detailsRetrieve detailed information about a specific PandaDoc Content Library Item (CLI) by its ID, including roles, fields with values, tokens with values, pricing information (pricing tables, products), metadata, tags, and modification timestamps.Read-onlyContent Library Item Details
Retrieve detailed information about a specific PandaDoc Content Library Item (CLI) by its ID, including roles, fields with values, tokens with values, pricing information (pricing tables, products), metadata, tags, and modification timestamps.
Inputs
idstringrequired- The ID of the Content Library Item to retrieve details for.
pandadoc_content_library_item_get_statusRetrieve the current processing status of a PandaDoc Content Library Item (CLI) by ID.Read-onlyContent Library Item Status
Retrieve the current processing status of a PandaDoc Content Library Item (CLI) by ID. Statuses: cli.UPLOADED (upload in progress, will transition to PROCESSED), cli.PROCESSED (successfully created and fully editable), cli.ERROR (upload failed). Use this to confirm a CLI is ready before invoking other CLI methods.
Inputs
idstringrequired- The ID of the Content Library Item to check the status of.
pandadoc_content_library_items_listList and search PandaDoc content library items.Read-onlyList Content Library Item
List and search PandaDoc content library items. Supports filtering by ID, folder, tag, deletion status, and a free-text name search, plus pagination. Returns a paginated array of content library item summaries (id, name, dates, version).
Inputs
countinteger- Number of content library items to return per page. Default 50, maximum 100.default
50 deletedboolean- If true, return only deleted (soft-deleted) content library items instead of active ones.
folder_uuidstring- The UUID of the folder where the content library items are stored.
item_idstring- Search for a specific content library item by its id.
pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 qstring- Search query. Filter by content library item name.
tagstring- Search tag. Filter by content library item tag.
pandadoc_document_attachment_downloadDownload the binary content of a PandaDoc document attachment by its attachment ID.Read-onlyDownload Document Attachment
Download the binary content of a PandaDoc document attachment by its attachment ID. The response is the raw file bytes (not JSON) — for text-like attachments this will be readable, for other formats (PDF, images, etc.) it will be binary data. Use the attachment ID from the document's attachment list.
Inputs
attachment_idstringrequired- The attachment UUID to download.
idstringrequired- The document UUID that owns the attachment.
pandadoc_document_attachment_get_detailsRetrieve details of a specific attachment on a PandaDoc document, including its UUID, creation date, creator details, and file name.Read-onlyDocument Attachment Details
Retrieve details of a specific attachment on a PandaDoc document, including its UUID, creation date, creator details, and file name.
Inputs
attachment_idstringrequired- The UUID of the attachment to retrieve.
idstringrequired- The UUID of the document that owns the attachment.
pandadoc_document_attachments_listList all attachments on a PandaDoc document.Read-onlyList Document Attachments
List all attachments on a PandaDoc document. Returns each attachment's UUID, creation date, creator details, and file name.
Inputs
idstringrequired- The UUID of the document whose attachments should be listed.
pandadoc_document_audit_trail_listRetrieve the full audit trail for a PandaDoc document, including detailed user actions such as sending, viewing, signing, and editing, along with metadata like timestamps, IP addresses, and user identity.Read-onlyList Document Audit Trail
Retrieve the full audit trail for a PandaDoc document, including detailed user actions such as sending, viewing, signing, and editing, along with metadata like timestamps, IP addresses, and user identity. Accessible to authorized workspace administrators only. Supports pagination via limit/offset.
Inputs
document_idstringrequired- Unique identifier of the document to retrieve the audit trail for.
limitinteger- Maximum number of items to return. Default 20, maximum 100.default
20 offsetinteger- Number of items to skip before starting to collect the result set. Default 0.default
0
pandadoc_document_downloadDownload a PDF copy of the document identified by id.Read-onlyDocument Download
Download a PDF copy of the document identified by id. The response is a binary PDF file, not JSON — save it to disk rather than parsing it as JSON. Optionally apply a text watermark (color, font size, opacity, text) and request the document bundle as a zip of separate per-section PDFs. May return 202 if the PDF is still being generated (retry shortly) or 409 if the document is not in a downloadable state.
Inputs
idstringrequired- The unique id of the document to download.
separate_filesboolean- Download the document bundle as a zip archive of separate PDFs, one per section, instead of a single combined PDF.default
false watermark_colorstring- HEX color code for the watermark text, e.g. #FF5733.
watermark_font_sizeinteger- Font size of the watermark text.
watermark_opacitynumber- Opacity of the watermark, in the range 0.0-1.0.
watermark_textstring- Text to render as a watermark across the downloaded PDF.
pandadoc_document_download_protectedDownload the final, audit-trail-protected PDF of a completed document identified by id.Read-onlyDownload Completed Document
Download the final, audit-trail-protected PDF of a completed document identified by id. The response is a binary PDF file, not JSON — save it to disk rather than parsing it as JSON. Optionally request the bundle as a zip of separate per-section PDFs. May return 202 if the PDF is still being generated (retry shortly) or 409 if the document has not yet reached a completed state.
Inputs
idstringrequired- The unique id of the completed document to download.
separate_filesboolean- Download the document bundle as a zip archive of separate PDFs, one per section, instead of a single combined PDF.default
false
pandadoc_document_esign_disclosureRetrieve the current version of the eSign disclosure text configured for a specified PandaDoc document.Read-onlyDocument eSign Disclosure
Retrieve the current version of the eSign disclosure text configured for a specified PandaDoc document. Returns whether the eSign disclosure feature is enabled, the company name, and the disclosure text (HTML) shown to signers.
Inputs
document_idstringrequired- The UUID of the document to retrieve the eSign disclosure text for.
pandadoc_document_fields_listReturn the list of fields for a particular PandaDoc document, including each field's UUID, type, current value, layout position, settings, and the recipient it is assigned to (if any).Read-onlyList Document Fields
Return the list of fields for a particular PandaDoc document, including each field's UUID, type, current value, layout position, settings, and the recipient it is assigned to (if any).
Inputs
idstringrequired- The document UUID to list fields for.
pandadoc_document_folders_listGet the list of folders that contain PandaDoc documents in your account.Read-onlyList Documents Folders
Get the list of folders that contain PandaDoc documents in your account. The root folder itself is not listed in the response. Supports pagination and optional filtering by parent folder.
Inputs
countinteger- Number of folders to return per page. Default is 50, maximum is 100.default
50 pageinteger- Page number of results to fetch.default
1 parent_uuidstring- The UUID of the parent folder whose subfolders you want to list. Omit to list folders located in the root folder.
pandadoc_document_get_detailsRetrieve full details of a PandaDoc document by its id, including recipients, fields, pricing tables, tokens, metadata, tags, and grand totals.Read-onlyDocument Details
Retrieve full details of a PandaDoc document by its id, including recipients, fields, pricing tables, tokens, metadata, tags, and grand totals. The document must not be in an uploaded/processing state (a 409 is returned if details are not yet available). Use the Document Status tool first to confirm the document has reached document.draft or later.
Inputs
idstringrequired- The unique id of the document to fetch details for.
pandadoc_document_get_statusRetrieve the current status of a PandaDoc document by its id, e.g.Read-onlyDocument Status
Retrieve the current status of a PandaDoc document by its id, e.g. document.draft, document.sent, document.completed. Also returns basic metadata (name, dates, version, uuid, links). Use this to poll a newly created document until it transitions out of document.uploaded into document.draft before further operations.
Inputs
idstringrequired- The unique id of the document to look up.
pandadoc_document_linked_objects_listList all CRM objects (e.g.Read-onlyList Linked Objects
List all CRM objects (e.g. deals, contacts) linked to a specific PandaDoc document. Returns each linked object's link id, CRM provider, entity type, and entity id.
Inputs
idstringrequired- The UUID of the document whose linked objects should be listed.
pandadoc_document_reminder_get_settingsRetrieve the current auto-reminder configuration for a specified PandaDoc document, including whether reminders are enabled, delivery method (email/sms), initial delay in days, and recurrence settings.Read-onlyDocument Auto Reminder Settings
Retrieve the current auto-reminder configuration for a specified PandaDoc document, including whether reminders are enabled, delivery method (email/sms), initial delay in days, and recurrence settings. Returns a 400 error if the document is in a final state (e.g., completed, paid, declined, or expired).
Inputs
document_idstringrequired- The UUID of the document to retrieve auto-reminder settings for.
pandadoc_document_reminder_get_statusRetrieve the auto-reminder status for a PandaDoc document.Read-onlyDocument Auto Reminder Status
Retrieve the auto-reminder status for a PandaDoc document. Returns, for each recipient with an active auto-reminder, their recipient_id and reminder status (sent, error, or scheduled).
Inputs
document_idstringrequired- The UUID of the document to check auto-reminder status for.
pandadoc_document_section_getRetrieve details (UUID, name, and parent document UUID) for a single document section.Read-onlyDocument Section Details
Retrieve details (UUID, name, and parent document UUID) for a single document section.
Inputs
document_idstringrequired- The ID of the document the section belongs to.
section_idstringrequired- The ID of the section to retrieve.
pandadoc_document_section_upload_statusPoll the status of an asynchronous document section upload (created via Create Document Section).Read-onlyDocument Section Upload Status
Poll the status of an asynchronous document section upload (created via Create Document Section). Returns the upload's status, which becomes 'document_sections_upload.PROCESSED' once processing completes.
Inputs
document_idstringrequired- The ID of the document the section upload belongs to.
upload_idstringrequired- The ID of the upload, returned by the Create Document Section (or from file upload) call.
pandadoc_document_sections_listRetrieve information about the sections (bundled sub-documents) within a PandaDoc document.Read-onlyList Document Sections
Retrieve information about the sections (bundled sub-documents) within a PandaDoc document. Returns each section's UUID and name.
Inputs
document_idstringrequired- The ID of the document to list sections for.
pandadoc_document_settings_getRetrieve the settings for a specified PandaDoc document, including language, whether a Qualified Electronic Signature (QES) is required, expiration in days, and whether Suggest Edits (redlining) is enabled.Read-onlyGet Document Settings
Retrieve the settings for a specified PandaDoc document, including language, whether a Qualified Electronic Signature (QES) is required, expiration in days, and whether Suggest Edits (redlining) is enabled.
Inputs
document_idstringrequired- Unique identifier of the document to retrieve settings for.
pandadoc_documents_listList and search PandaDoc documents.Read-onlyList Documents
List and search PandaDoc documents. Supports filtering by template, form, folder, contact, status, tag, metadata-derived free text search, and created/modified/completed date ranges, plus pagination and sorting. Returns a paginated array of document summaries (id, name, status, dates, version).
Inputs
completed_fromstring- Only return documents with date_completed on or after this ISO 8601 datetime.
completed_tostring- Only return documents with date_completed before this ISO 8601 datetime.
contact_idstring- Filter by recipient or approver contact_id.
countinteger- Number of documents to return per page. Default 50, maximum 100.default
50 created_fromstring- Only return documents with date_created on or after this ISO 8601 datetime.
created_tostring- Only return documents with date_created before this ISO 8601 datetime.
deletedboolean- If true, return only deleted (soft-deleted) documents instead of active ones.
document_idstring- Search for a specific document by its id.
folder_uuidstring- Filter by the folder where the documents are stored.
form_idstring- Filter by parent form. Cannot be used together with template_id.
membership_idstring- Filter documents by the owner's membership_id.
modified_fromstring- Only return documents with date_modified on or after this ISO 8601 datetime.
modified_tostring- Only return documents with date_modified before this ISO 8601 datetime.
order_bystring- Sort field for the results. Prefix with '-' for descending order (e.g. '-date_created'). Defaults to 'date_status_changed'.one of
namedate_createddate_status_changeddate_of_last_actiondate_modifieddate_sentdate_completeddate_expirationdate_declinedstatus-name-date_created-date_status_changed-date_of_last_action-date_modified-date_sent-date_completed-date_expiration-date_declined-statusdefaultdate_status_changed pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 qstring- Filter documents by name or reference number (stored on the template level).
statusinteger- Filter documents by status code: 0=draft, 1=sent, 2=completed, 3=uploaded, 4=error, 5=viewed, 6=waiting_approval, 7=approved, 8=rejected, 9=waiting_pay, 10=paid, 11=voided, 12=declined, 13=external_review, 14=scheduled.one of
01234567891011121314 status_neinteger- Exclude documents with this status code. Same code mapping as Status: 0=draft, 1=sent, 2=completed, 3=uploaded, 4=error, 5=viewed, 6=waiting_approval, 7=approved, 8=rejected, 9=waiting_pay, 10=paid, 11=voided, 12=declined, 13=external_review, 14=scheduled.one of
01234567891011121314 tagstring- Filter documents by tag.
template_idstring- Filter by parent template. Cannot be used together with form_id.
pandadoc_documents_list_by_linked_objectList PandaDoc documents that are linked to a specific CRM entity (e.g.Read-onlyList Documents by Linked Object
List PandaDoc documents that are linked to a specific CRM entity (e.g. a HubSpot deal or a Pipedrive deal). Requires the entity's id, entity type, and CRM provider name; supports optional sorting and filtering by owner.
Inputs
entity_idstringrequired- The unique identifier of the linked CRM entity, e.g. from a HubSpot deal URL.
entity_typestringrequired- The type of the linked entity (e.g. 'deal'). See https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms for available entity types.
providerstringrequired- The CRM provider name (lowercase), e.g. 'hubspot' or 'pipedrive'. See https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms for available providers.
order_bystring- Sort field for results. Defaults to '-date_created' (most recently created first).default
-date_created owner_idsarray- Filter results to documents owned by one or more of these membership (owner) IDs.
pandadoc_forms_listRetrieve a paginated list of PandaDoc forms with optional filtering by status and name, and sorting options.Read-onlyList Forms
Retrieve a paginated list of PandaDoc forms with optional filtering by status and name, and sorting options. Returns form id, name, dates, and status.
Inputs
ascboolean- Sort results in ascending order when true, descending when false.
countinteger- Number of forms to return per page. Default is 50, maximum is 100.default
50 namestring- Filter forms by name (exact or partial match on the form's name).
order_bystring- Field to sort the forms dataset by.one of
nameresponsesstatuscreated_datemodified_date pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 statusarray- Filter forms by one or more statuses: draft, active, or disabled.
pandadoc_member_getRetrieve a member's details by membership id, including user_id, email, name, active status, workspace, role, user license, and creation/modification dates.Read-onlyMember Details
Retrieve a member's details by membership id, including user_id, email, name, active status, workspace, role, user license, and creation/modification dates.
Inputs
idstringrequired- The membership id of the member to retrieve.
pandadoc_member_get_currentReturn the member details of the current user (the owner of the API key), including user_id, membership_id, email, name, active workspace, role, user license, and creation/modification dates.Read-onlyCurrent Member Details
Return the member details of the current user (the owner of the API key), including user_id, membership_id, email, name, active workspace, role, user license, and creation/modification dates.
Inputs
This tool takes no inputs.
pandadoc_members_listRetrieve all member details for the workspace implied by the OAuth token.Read-onlyList Members
Retrieve all member details for the workspace implied by the OAuth token. For each member, the workspace field shows their currently active workspace, which can differ from the workspace implied by the authenticated token. Returns an array of member objects (user_id, membership_id, email, first_name, last_name, is_active, workspace, workspace_name, email_verified, role, user_license, date_created, date_modified). This endpoint takes no parameters.
Inputs
This tool takes no inputs.
pandadoc_notaries_listRetrieve a list of notaries associated with your organization.Read-onlyList Notaries
Retrieve a list of notaries associated with your organization. Requires the Notary add-on to be enabled. Notaries can currently only be added to an organization manually through the PandaDoc Notary UI. Supports filtering by status and commission state, sorting, and pagination.
Inputs
commission_statestring- Comma-separated list of commission states to filter by, e.g. 'California,Arizona'.
limitinteger- Maximum number of results to return. Defaults to 50, maximum 100.default
50 offsetinteger- Number of results to skip. Defaults to 0.default
0 order_bystring- Sort field. Prefix with '-' for descending order. Defaults to 'email'.one of
email-emailstatus-statusname-namedefaultemail statusstring- Comma-separated list of statuses to filter by. Valid values: INVITED, UNDER_REVIEW, ACTIVE, REJECTED, INACTIVE.
pandadoc_notarization_request_getGet details about a notarization request by its id, including status, creator, invitees, signed documents (with download links, available only once COMPLETED), session recording info, timestamps, and termination reason/details if the session did not complete successfully.Read-onlyNotarization Request Details
Get details about a notarization request by its id, including status, creator, invitees, signed documents (with download links, available only once COMPLETED), session recording info, timestamps, and termination reason/details if the session did not complete successfully. Signed document and recording links expire in 1 hour.
Inputs
session_request_idstringrequired- The unique identifier (UUID) of the notarization request.
pandadoc_notarization_requests_listRetrieve a paginated list of notarization requests for your organization.Read-onlyList Notarization Requests
Retrieve a paginated list of notarization requests for your organization. Requires the Notary On-Demand or Notary add-on. By default only returns requests created by the API key owner, unless they have the 'Can view any notarization request' permission. Supports filtering by status, creator, or document, and sorting.
Inputs
created_by_user_idstring- Comma-separated list of creator user IDs to filter by.
document_idstring- Comma-separated list of document IDs to filter by.
limitinteger- Maximum number of results to return. Defaults to 50, maximum 100.default
50 offsetinteger- Number of results to skip. Defaults to 0.default
0 order_bystring- Sort field. Prefix with '-' for descending order. Defaults to 'date_created' ascending.one of
status-statusdate_created-date_createddate_completed-date_completeddefaultdate_created statusstring- Comma-separated list of statuses to filter by. Valid values: DRAFT, SENT, WAITING_FOR_NOTARY, ACCEPTED, LIVE, COMPLETED, INCOMPLETE, CANCELLED.
pandadoc_sms_opt_outs_listList recent SMS communication preference changes (opt-in/opt-out) for phone numbers associated with PandaDoc documents, optionally filtered by a date/time range.Read-onlyRecent SMS Opt-out
List recent SMS communication preference changes (opt-in/opt-out) for phone numbers associated with PandaDoc documents, optionally filtered by a date/time range. Returns an array of phone_number, status ('opt-in' or 'opt-out'), and the timestamp the status changed.
Inputs
timestamp_fromstring- Only return opt-out/opt-in changes on or after this ISO 8601 datetime.
timestamp_tostring- Only return opt-out/opt-in changes before this ISO 8601 datetime.
pandadoc_template_folders_listList the folders that contain Templates in your PandaDoc account.Read-onlyList Templates Folders
List the folders that contain Templates in your PandaDoc account. Optionally filter by parent folder UUID and paginate results. The root folder itself is not included in the response.
Inputs
countinteger- Number of template folders to return per page. Default 50, maximum 100.default
50 pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 parent_uuidstring- The UUID of the parent folder whose child folders should be listed. Omit to list folders in the root folder.
pandadoc_template_get_detailsGet detailed information about a PandaDoc template by ID, including basic template information (name, author), roles, fields with values, tokens with values, pricing information (pricing tables, products, quotes), metadata, tags, content placeholders, and modification timestamps.Read-onlyTemplate Details
Get detailed information about a PandaDoc template by ID, including basic template information (name, author), roles, fields with values, tokens with values, pricing information (pricing tables, products, quotes), metadata, tags, content placeholders, and modification timestamps.
Inputs
idstringrequired- The ID of the template to retrieve details for.
pandadoc_template_get_statusRetrieve the current processing status of a PandaDoc template by ID.Read-onlyTemplate Status
Retrieve the current processing status of a PandaDoc template by ID. Statuses: template.UPLOADED (upload in progress, will transition to PROCESSED), template.PROCESSED (successfully created and fully editable), template.ERROR (upload failed). Use this to confirm a template is ready before invoking other template methods, such as Template Update.
Inputs
idstringrequired- The ID of the template to check the status of.
pandadoc_template_settings_getRetrieve the settings for a PandaDoc template.Read-onlyGet Template Settings
Retrieve the settings for a PandaDoc template. Currently only the document language setting is supported and returned (e.g. 'en-US', 'fr-FR').
Inputs
template_idstringrequired- Unique identifier of the template to retrieve settings for.
pandadoc_templates_listList and search PandaDoc templates.Read-onlyList Templates
List and search PandaDoc templates. Supports filtering by name search query, template ID, folder, tag(s), shared/deleted status, plus pagination. Returns a paginated array of template summaries (id, name, dates, version).
Inputs
countinteger- Number of templates to return per page. Default 50, maximum 100.default
50 deletedboolean- If true, return only deleted (soft-deleted) templates instead of active ones.
fieldsstring- Additional field to include in each result. Currently only 'content_date_modified' is supported.one of
content_date_modified folder_uuidstring- Filter by the folder where the templates are stored.
idstring- Search for a specific template by its id.
pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 qstring- Filter templates by name.
sharedboolean- If true, return only templates shared with the account.
tagarray- Filter templates by one or more tags. Example: ["onboarding"].
pandadoc_user_getGet details of a single user in the PandaDoc organization by their user ID.Read-onlyGet User Details by ID
Get details of a single user in the PandaDoc organization by their user ID. Returns email, first/last name, phone number, license, organization-owner flag, and workspace memberships (role, workspace_id, membership_id).
Inputs
user_idstringrequired- The unique identifier of the user to fetch.
pandadoc_users_listList users in the PandaDoc organization.Read-onlyList Users
List users in the PandaDoc organization. Supports pagination and optionally including removed users. Returns the total count and an array of users (user_id, email, first_name, last_name, phone_number, license, ownership flag, and workspace memberships).
Inputs
countinteger- Number of users to return per page. Default and maximum 50.default
50 pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 show_removedboolean- Whether to include removed (deactivated) users in the results.default
true
pandadoc_workspaces_listList workspaces in the PandaDoc organization.Read-onlyList Workspaces
List workspaces in the PandaDoc organization. Supports free-text search on workspace name and pagination. Returns the total count and an array of workspaces (id, name, date_created, owner email).
Inputs
countinteger- Number of workspaces to return per page. Default 50, maximum 100.default
50 pageinteger- Page number of results to fetch. Increase to page through additional results.default
1 qstring- Filter workspaces by name using a free-text search.
pandadoc_catalog_item_createCreate a new product catalog item with a title and a default price configuration (currency, price, cost, pricing method, billing type/cycle, and optional volume tiers).WriteCreate Catalog Item
Create a new product catalog item with a title and a default price configuration (currency, price, cost, pricing method, billing type/cycle, and optional volume tiers). Optionally set a category, SKU, description, item type, custom fields, images, and bundle items (for bundle-type items). Returns the created item with its generated UUID and default price configuration.
Inputs
currencystringrequired- ISO 4217 currency code for the item's default price configuration.
pricing_methodintegerrequired- Pricing method for the item: 0 = flat price, 1 = volume/tiered pricing.one of
01 titlestringrequired- The name/title of the catalog item.
billing_cyclestring- Billing cycle identifier, required when billing_type is 'recurring'.
billing_typestring- Billing type for the item's price configuration.one of
one_timerecurringdefaultone_time bundle_itemsarray- Items included in a bundle, used only when type is 'bundle'. Each entry is an object with 'quantity' and 'item_or_uuid' (an existing catalog item's UUID).
category_idstring- ID of the category to assign this item to.
costnumber- Cost of the item (for margin calculations).
custom_fieldsarray- Custom field name/value pairs for the item.
descriptionstring- Description of the catalog item.
imagesarray- Images for the item. Each entry is an object with 'src' (image URL), 'order' (display order), and 'is_main' (whether it's the primary image).
pricenumber- Flat price of the item. Used when pricing_method is 0. Set to null if using tiered pricing.
skustring- SKU for the item. If omitted, PandaDoc generates one automatically.
tiersarray- Volume pricing tiers, used only when pricing_method is 1. Each entry is an object with 'value' (price at that tier) and 'min_qty' (minimum quantity for the tier).
typestring- Catalog item type. Defaults to 'regular'.one of
regularbundledefaultregular
pandadoc_catalog_item_updateUpdate an existing product catalog item (product or bundle) in PandaDoc by its item UUID.WriteUpdate Catalog Item
Update an existing product catalog item (product or bundle) in PandaDoc by its item UUID. Supports updating the title, category, bundle composition, and the default product variant (SKU, description, images, custom fields, and price configuration). Returns the updated catalog item.
- Idempotent
Inputs
item_uuidstringrequired- The UUID of the catalog item to update.
bundle_itemsarray- List of items included in the bundle. Each entry has a 'quantity' and an 'item_or_uuid' (either an existing catalog item UUID as a string, or an inline custom bundle item object). Only applicable when type is 'bundle'. Passed through as-is to the PandaDoc API.
category_idstring- UUID of the category to assign this item to, or null to remove it from its current category.
product_variantobject- The default product variant to update: sku, description, images (array of {is_main, order, src}), custom_fields (array of {name, value}), and price_configuration ({currency, price, cost, billing_type, billing_cycle, tiers, pricing_method}). Passed through as-is to the PandaDoc API.
titlestring- New title for the catalog item.
typestring- Whether the item is a regular product or a bundle of other items.one of
regularbundle
pandadoc_contact_createAdd a new contact into your PandaDoc contacts list.WriteCreate Contact
Add a new contact into your PandaDoc contacts list. All fields are optional, but at minimum an email or name is recommended for the contact to be useful in documents. Returns the created contact object including its generated id.
Inputs
citystring- The contact's city name.
companystring- The contact's company name.
countrystring- The contact's country name.
emailstring- The contact's email address.
first_namestring- The contact's first name.
job_titlestring- The contact's job title.
last_namestring- The contact's last name.
phonestring- The contact's phone number.
postal_codestring- The contact's postal or ZIP code.
statestring- The contact's state or region name.
street_addressstring- The contact's street address.
pandadoc_contact_updateUpdate the details of an existing PandaDoc contact by its id.WriteUpdate Contact
Update the details of an existing PandaDoc contact by its id. Note: the email address and country cannot be changed via this endpoint. Returns the updated contact object.
- Idempotent
Inputs
idstringrequired- The unique identifier of the contact to update.
citystring- The contact's new city name.
companystring- The contact's new company name.
first_namestring- The contact's new first name.
job_titlestring- The contact's new job title.
last_namestring- The contact's new last name.
phonestring- The contact's new phone number.
postal_codestring- The contact's new postal or ZIP code.
statestring- The contact's new state or region name.
street_addressstring- The contact's new street address.
pandadoc_content_library_item_createCreate a new Content Library Item (CLI) in PandaDoc, either as an empty item or by importing a PDF from a publicly accessible HTTPS URL.WriteCreate Content Library Item
Create a new Content Library Item (CLI) in PandaDoc, either as an empty item or by importing a PDF from a publicly accessible HTTPS URL. If a url is provided, PandaDoc processes the PDF asynchronously; poll pandadoc_content_library_item_get_status to check when the item reaches the 'cli.PROCESSED' state.
Inputs
namestring- The name of the Content Library Item.
urlstring- Secure (HTTPS) and publicly accessible URL to a PDF document to import as the content library item's content. If omitted, an empty content library item is created.
pandadoc_document_append_content_library_itemAppend a Content Library Item (CLI) to a PandaDoc document.WriteAppend Content Library Item to a Document
Append a Content Library Item (CLI) to a PandaDoc document. Returns the list of appended CLI pages and a block name mapping (tables, pricing tables, images, texts) showing how the CLI's content block names were renamed to avoid collisions in the resulting document.
Inputs
cli_idstringrequired- The ID of the Content Library Item (CLI) to append to the document's first section.
idstringrequired- The ID of the document to append the Content Library Item to.
pagesarray- Optional list of CLI page overrides. Each entry is an object with 'index' (0-based page index within the CLI) and 'name' (the name to apply to that page in the resulting document). Example: [{"index": 0, "name": "Introduction"}].
pandadoc_document_attachment_createAttach a file to a PandaDoc document by URL.WriteCreate Document Attachment
Attach a file to a PandaDoc document by URL. PandaDoc fetches the file from the given source URL and stores it as an attachment. Optionally set a custom display name for the uploaded file.
Inputs
idstringrequired- The UUID of the document to attach the file to.
sourcestringrequired- URL of the file to be attached to the document. PandaDoc will download the file from this URL.
namestring- Optional display name to set for the uploaded file. If omitted, PandaDoc derives a name from the source URL.
pandadoc_document_change_statusManually change the status of a PandaDoc document identified by id to one of four allowed target statuses: Completed (code 2), Paid (code 10, requires a connected payment app), Expired (code 11), or Declined (code 12).WriteDocument Status Change
Manually change the status of a PandaDoc document identified by id to one of four allowed target statuses: Completed (code 2), Paid (code 10, requires a connected payment app), Expired (code 11), or Declined (code 12). Not every transition is valid for every current status (e.g. a document already Paid cannot be changed to Expired) — an invalid transition returns 409. Optionally attach a private note explaining the change and notify recipients by email. Returns no content on success.
Inputs
idstringrequired- The unique id of the document whose status is being changed.
statusintegerrequired- Numeric code for the target document status: 2=Completed (document.completed), 10=Paid (document.paid, requires a connected payment app), 11=Expired (document.voided), 12=Declined (document.declined).one of
2101112 notestring- A private note explaining the reason for the manual status change. Not visible to recipients.
notify_recipientsboolean- If true, sends a notification email about the status change to all document recipients.
pandadoc_document_createCreate a new PandaDoc document either from an existing template (provide template_uuid) or from a publicly accessible PDF URL (provide url).WriteCreate Document
Create a new PandaDoc document either from an existing template (provide template_uuid) or from a publicly accessible PDF URL (provide url). Exactly one of template_uuid or url must be supplied. Supports pre-filling recipients, merge fields, tokens, pricing tables, tables, images, texts, metadata, and tags. The response returns the new document in an initial 'uploaded' status; poll the Document Status tool until it becomes 'draft' before further operations.
Inputs
namestringrequired- The name of the document to create.
content_placeholdersarray- Only used when creating from a template. Array used to inject Content Library items into placeholder blocks.
detect_title_variablesboolean- Only used when creating from a template. If true, detects and replaces variables present in the document title.
fieldsobject- Object mapping merge field names to {"value": ...} objects to pre-fill field values (text, checkbox, date, etc).
folder_uuidstring- UUID of the folder where the new document should be stored.
imagesarray- Only used when creating from a template. Array of {name, urls} objects to replace image blocks by name.
metadataobject- Arbitrary key-value data to associate with the document, returned in later document detail requests.
ownerobject- Object with a membership_id field identifying which workspace member owns the document, e.g. {"membership_id": "QMDSzwabfFzTgjW6KijHyu"}.
parse_form_fieldsboolean- Only used when creating from a PDF url. Set true if the source PDF has AcroForm fields, false if it uses PandaDoc field tags.
pricing_tablesarray- Only used when creating from a template. Array of pricing table objects to populate pricing table blocks.
recipientsarray- Array of recipient objects (email, first_name, last_name, role, etc). Required when creating from template_uuid; optional when creating from a PDF url.
tablesarray- Only used when creating from a template. Array of table objects to populate table blocks.
tagsarray- Array of string tags to mark the document with.
template_uuidstring- The UUID of the PandaDoc template to create this document from. Required if url is not provided; cannot be combined with url.
textsarray- Only used when creating from a template. Array of {name, data} objects to replace text blocks by name.
tokensarray- Array of {name, value} objects used to initialize document variables.
urlstring- A secure (HTTPS) and publicly accessible URL to a PDF document to create this document from. Required if template_uuid is not provided; cannot be combined with template_uuid.
use_form_field_propertiesstring- Set to 'yes', '1', or 'true' to respect PDF form field properties (like required) when uploading a PDF with form fields.
pandadoc_document_create_editing_sessionCreate a new editing session for the PandaDoc Embedded Editor for a document that has draft status.WriteCreate Document Editing Session
Create a new editing session for the PandaDoc Embedded Editor for a document that has draft status. The response includes an E-Token (token) required to open the document in the Embedded Editor. Only one editing session can be active at a time for a specific user-document pair; creating a new one invalidates the previous session. A maximum of 250 editing sessions can be created for a single document per week.
Inputs
emailstringrequired- Email address of the user to create the editing session for.
idstringrequired- The ID of the document (must be in draft status) to create the editing session for.
lifetimeinteger- Lifetime of the E-Token in seconds. Minimum 60, maximum 86400. Defaults to 3600 (1 hour).default
3600
pandadoc_document_create_signing_sessionCreate a document session (Embedded Sign session) for a recipient to view and sign a document.WriteCreate Document Session for Embedded Sign
Create a document session (Embedded Sign session) for a recipient to view and sign a document. Returns a session id and expiration time that can be used to build an embedded signing link.
Inputs
idstringrequired- The ID of the document to create the signing session for.
recipientstringrequired- Email address of the recipient who will receive access to the document session.
lifetimenumber- The duration in seconds for which the document session link remains valid. Defaults to 3600 (1 hour) if not specified. For security, PandaDoc recommends setting this to less than one year (e.g. 31535999).default
3600
pandadoc_document_fields_createCreate one or more fields (text, checkbox, date, dropdown, radio buttons, signature, etc.) on a PandaDoc document at specific page positions.WriteCreate Document Fields
Create one or more fields (text, checkbox, date, dropdown, radio buttons, signature, etc.) on a PandaDoc document at specific page positions. Accepts an array of field definitions, each specifying the field type and layout (page, position, size). For 21 CFR Part 11 (CFR11) compliant workspaces, signature fields must be at least 108x33 in size. Returns the created fields with their assigned UUIDs.
Inputs
fieldsarrayrequired- Array of field objects to place on the document. Each item requires 'type' (e.g. text, checkbox, date, dropdown, radio_buttons, signature, initials) and 'layout' (page, position {offset_x, offset_y, anchor_point}, style {width, height}). Optional per-field keys: 'field_id', 'merge_field', 'assigned_to' (recipient UUID), and 'settings' (type-specific options like required, placeholder, options list). Example: [{"type": "text", "layout": {"page": 1, "position": {"offset_x": 1, "offset_y": 1, "anchor_point": "topleft"}, "style": {"width": 1, "height": 1}}}]
idstringrequired- The document UUID to create fields on.
pandadoc_document_fields_update_assignmentAssign, reassign, or unassign fields on a PandaDoc document to recipients.WriteUpdate Document Fields Assignment
Assign, reassign, or unassign fields on a PandaDoc document to recipients. Supports bulk operations by accepting multiple field assignment items in a single request. The document must be in 'Draft' status and you must have the 'Can Edit Document' permission. Returns no content on success.
- Idempotent
Inputs
fieldsarrayrequired- Array of field assignment operations. Each item must include 'field_id' (UUID of the field) and 'assigned_to' (UUID of the recipient to assign to, or null to unassign the field). Example: [{"field_id": "d6948f39-612a-4626-a439-ca9e0cbbda7c", "assigned_to": "tf5dGS3Tmu3cj228ao6fnc"}]
idstringrequired- The document UUID whose field assignments should be updated.
pandadoc_document_folder_createCreate a new folder to store PandaDoc documents.WriteCreate Documents Folder
Create a new folder to store PandaDoc documents. Optionally nest it inside an existing folder by specifying the parent folder's UUID; omit to create a top-level folder in the root.
Inputs
namestringrequired- Name for the new documents folder.
parent_uuidstring- UUID of the parent folder to create this new folder inside. Omit to create the folder at the root level.
pandadoc_document_folder_renameRename a documents folder in PandaDoc by its UUID.WriteRename Documents Folder
Rename a documents folder in PandaDoc by its UUID. Returns the updated folder object with uuid, name, and date_created.
- Idempotent
Inputs
idstringrequired- The UUID of the documents folder to rename.
namestringrequired- The new name to assign to the documents folder.
pandadoc_document_linked_object_createLink a PandaDoc document to a CRM entity (e.g.WriteCreate Linked Object
Link a PandaDoc document to a CRM entity (e.g. a deal or contact) by specifying the CRM provider, entity type, and entity id. PandaDoc validates that the entity exists. Returns the created link's id and any child links.
Inputs
entity_idstringrequired- Unique identifier of the CRM entity to link. PandaDoc validates that the entity exists.
entity_typestringrequired- Entity type to link, e.g. 'deal'. See https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms for available entity types.
idstringrequired- The UUID of the document to link the CRM entity to.
providerstringrequired- CRM provider name (lowercase), e.g. 'pipedrive'. See https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms for available providers.
pandadoc_document_move_to_folderMove a PandaDoc document to a folder by specifying the document ID and the destination folder ID.WriteDocument Move to Folder
Move a PandaDoc document to a folder by specifying the document ID and the destination folder ID. Returns no content on success.
- Idempotent
Inputs
folder_idstringrequired- The ID of the destination folder to move the document into.
idstringrequired- The ID of the document to move.
pandadoc_document_recipient_addAdd a CC recipient (an existing contact or contact group) to a PandaDoc document.WriteAdd Document Recipient
Add a CC recipient (an existing contact or contact group) to a PandaDoc document. Requires the 'Can Manage Recipients' permission, and the contact must already exist (create it first via the Create Contact tool if needed). CC recipients can be added in any document status except 'Expired' (voided) and 'Declined'. If the document has already been sent/viewed/completed/is waiting for payment/paid, the new CC recipient receives an instant email notification granting document access. Returns the new recipient's ID.
Inputs
contact_idstringrequired- The UUID of the existing contact or contact group to add as a CC recipient. Retrieve via the List Contacts tool.
idstringrequired- The document UUID to add the CC recipient to.
kindstring- Whether Contact ID refers to a single contact or a contact group. Defaults to 'contact'.one of
contactcontact_groupdefaultcontact
pandadoc_document_recipient_reassignReassign a document recipient's fields to a different contact (change signer).WriteChange Signer (Reassign Document Recipient)
Reassign a document recipient's fields to a different contact (change signer). Requires the 'Can Manage Recipients' permission, and the replacement contact must already exist (create it first with the Create Contact tool). You can reassign fields to another signer only before the original signer has signed; once reassigned, the original signer is entirely removed from the document (re-add them as a CC recipient if needed). If the document has already been sent, the new signer's pre-filled fields are reset; in Draft status they are preserved.
Inputs
contact_idstringrequired- The contact UUID of the replacement signer. Retrieve it with the List Contacts tool by searching for the contact's name or email.
document_idstringrequired- The UUID of the document containing the recipient.
recipient_idstringrequired- The UUID of the original signer's recipient record to reassign.
kindstring- The kind of entity referenced by contact_id.one of
contactcontact_groupdefaultcontact
pandadoc_document_recipient_updateModify a recipient's personal details (name, email, phone, company, address, etc.) on a PandaDoc document, or rename a recipient group and/or replace its members.WriteUpdate Document Recipient
Modify a recipient's personal details (name, email, phone, company, address, etc.) on a PandaDoc document, or rename a recipient group and/or replace its members. For an individual recipient, provide any of the personal-detail fields you want to change; only provided fields are updated. For a recipient group, provide 'group_name' and/or 'group_members' (the full replacement membership list, matched by email) instead — at least one of those two must be set, and 'group_members' must contain at least one member if provided. Editable document statuses vary by recipient type; see PandaDoc docs. Returns no content on success.
- Idempotent
Inputs
idstringrequired- The document UUID that owns the recipient.
recipient_idstringrequired- The recipient (or recipient group) UUID to update.
citystring- New city for an individual recipient.
companystring- New company name for an individual recipient.
countrystring- New country for an individual recipient.
emailstring- New email address for an individual recipient. Cannot be an email already used by another contact, and cannot be used to change a PandaDoc user's email.
first_namestring- New first name for an individual recipient.
group_membersarray- Full replacement list of the recipient group's members. Use only when Recipient ID refers to a group. Each item is an object with 'email' (required, used to match existing members) and optionally 'first_name'/'last_name'. Members omitted from this list are removed from the group; new entries are added. Must contain at least one member if provided. Example: [{"email": "kept.member@pandadoc.com"}, {"email": "new.member@pandadoc.com", "first_name": "New", "last_name": "Member"}]
group_namestring- New name for a recipient group. Use only when Recipient ID refers to a group. Max length 120.
last_namestring- New last name for an individual recipient.
phonestring- New phone number for an individual recipient.
postal_codestring- New postal code for an individual recipient.
statestring- New state/region for an individual recipient.
street_addressstring- New street address for an individual recipient.
titlestring- New job title for an individual recipient.
pandadoc_document_reminder_update_settingsConfigure automatic reminders sent to recipients of a PandaDoc document after its initial dispatch.WriteUpdate Document Auto Reminder Settings
Configure automatic reminders sent to recipients of a PandaDoc document after its initial dispatch. Set whether reminders are enabled, the delivery method (email/sms), the initial delay before the first reminder, and whether reminders recur (and at what frequency). Returns a 400 error if the document is in a final state (e.g., completed, paid, declined, or expired). To disable reminders, set enabled to false (other fields are then optional).
- Idempotent
Inputs
document_idstringrequired- The UUID of the document to update auto-reminder settings for.
enabledbooleanrequired- Toggles auto-reminders for the document. If true, reminders are scheduled based on the other configuration fields provided. If false, all other fields are optional.
delivery_methodstring- The method used to deliver reminders. One of: email, sms. Required when enabling reminders.one of
emailsms initial_delay_daysinteger- Number of days to wait after sending the document before the first reminder is sent. Must be between 1 and 180. Required when enabling reminders.
is_recurringboolean- If true, reminders are sent repeatedly at the interval configured in recurrence_frequency_days after the initial reminder.
recurrence_frequency_daysinteger- Number of days between recurring reminders. Applicable only when is_recurring is true. Must be between 1 and 180.
pandadoc_document_revert_to_draftRevert a PandaDoc document back to draft status so it can continue to be edited.WriteMove Document to Draft
Revert a PandaDoc document back to draft status so it can continue to be edited. Works for any document status except Removed. Signature and Initials fields are cleared (all other fields stay filled in). Recipients are NOT notified, so the document must be resent for recipients to sign the updated version.
- Idempotent
Inputs
idstringrequired- The ID of the document to revert to draft status.
pandadoc_document_section_uploadAdd a new section (bundle) to an existing PandaDoc document, either from a PandaDoc template (set template_uuid) or from a file reachable by a public HTTPS URL (set url).WriteCreate Document Section
Add a new section (bundle) to an existing PandaDoc document, either from a PandaDoc template (set template_uuid) or from a file reachable by a public HTTPS URL (set url). Exactly one of template_uuid or url must be provided. This is an asynchronous operation: a successful call returns an upload record with status 'document_sections_upload.UPLOADED'; poll the Document Section Upload Status tool until it becomes 'document_sections_upload.PROCESSED'. Pricing tables and content placeholders are not supported by this tool.
Inputs
document_idstringrequired- The ID of the document to add the section to.
recipientsarrayrequired- The list of recipients for the section. Each object must include email; role, first_name and last_name are optional. If role is passed, that person is assigned all fields matching their role; otherwise they receive a read-only link.
fieldsobject- Field name/value pairs to pre-fill fields used in a template. Signature fields cannot be pre-filled.
merge_field_scopestring- Determines how the fields/tokens are mapped when creating a section: 'document' updates fields across the entire document (default); 'upload' only updates fields from the created section, appending the merge field with the upload ID.one of
documentuploaddefaultdocument namestring- Name for the new section.
parse_form_fieldsboolean- Set true when creating a section from a PDF with form fields, or false when uploading a PDF with field tags. Only relevant when using url.
tagsarray- One or more tags to mark the section's document with.
template_uuidstring- The ID of the PandaDoc template to create the section from. Provide either this or url, not both.
tokensarray- List of token (variable) name/value pairs to pre-fill tokens used in a template.
urlstring- Secure (HTTPS) and publicly accessible URL to a PDF, DocX, or RTF file to create the section from. Provide either this or template_uuid, not both.
pandadoc_document_sendSend a PandaDoc document (which must be in draft status) to its recipients for viewing/signing.WriteSend Document
Send a PandaDoc document (which must be in draft status) to its recipients for viewing/signing. Optionally customize the email subject and message, set a sender, control forwarding permissions, set a reply-to address, suppress notifications with silent mode, and select approvers. Returns 409 if the document is not in a sendable state and 423 if it is locked by another operation.
Inputs
idstringrequired- The unique id of the document to send.
forwarding_settingsobject- Controls document/signature forwarding: {"forwarding_allowed": bool, "forwarding_with_reassigning_allowed": bool}.
messagestring- A message that will be sent by email with a link to the document to sign.
reply_tostring- Email address used as the reply-to address. Requires the feature to be enabled for the account by PandaDoc support.
selected_approversobject- Configuration for selected approvers, with an array of approval steps ({id, group}).
senderobject- Sets the sender of the document as {"membership_id": "..."} or {"email": "..."}.
silentboolean- If true, disables email notifications for recipients and the sender, and disables scheduled reminders (manual reminders still possible). Does not affect the Approve document notification.
subjectstring- Value used as the email subject when the document is sent.
pandadoc_document_send_manual_reminderSend a manual reminder to one or more recipients of a PandaDoc document.WriteSend Manual Reminder
Send a manual reminder to one or more recipients of a PandaDoc document. Each recipient can be reminded via email and/or SMS (per delivery_methods), and email reminders can be customized with a subject and message. The document sender's details are used automatically in the From field of email reminders.
Inputs
document_idstringrequired- The UUID of the document whose recipients should receive a reminder.
remindersarrayrequired- A list of reminders to send to specific recipients. Each entry specifies the recipient_id, which delivery_methods to use (email and/or sms), and an optional email_customization object (subject/message, only used when delivery_methods.email is true). Example: [{"recipient_id":"2eWSKSvVqmuVCnuUK3iWwD","delivery_methods":{"email":true,"sms":false}}]
pandadoc_document_settings_updateUpdate the settings for a specified PandaDoc document: language, whether a Qualified Electronic Signature (QES) is required, document expiration in days, and whether Suggest Edits (redlining) is enabled.WriteUpdate Document Settings
Update the settings for a specified PandaDoc document: language, whether a Qualified Electronic Signature (QES) is required, document expiration in days, and whether Suggest Edits (redlining) is enabled. Suggest Edits can only be changed while the document is in 'draft' status. Only the fields you provide are updated; omitted fields are left unchanged. Returns the full updated settings object.
- Idempotent
Inputs
document_idstringrequired- Unique identifier of the document to update settings for.
expires_ininteger- Document expiration in days. Minimum is 1 day.
languagestring- Document language code.one of
en-USfr-FRit-ITes-ESnl-NLde-DEpt-BRpt-PTpl-PLsv-SEcs-CZda-DKel-GRhu-HUnb-NOro-RObg-BG qualified_electronic_signatureboolean- Whether the document requires a Qualified Electronic Signature (QES) during signing. If true, signers must complete the document using a third-party qualified electronic signature provider.
suggest_editsboolean- Enables or disables Suggest Edits (redlining) for the document. Can only be changed while the document is in 'draft' status.
pandadoc_document_transfer_ownershipTransfer ownership of a PandaDoc document to another workspace member by specifying the document ID and the target member's membership_id.WriteUpdate Document Ownership
Transfer ownership of a PandaDoc document to another workspace member by specifying the document ID and the target member's membership_id. Returns no content on success. Use the List Members endpoint to find a valid membership_id.
- Idempotent
Inputs
idstringrequired- The ID of the document whose ownership should be transferred.
membership_idstringrequired- The unique identifier of the workspace member who will become the new owner of the document.
pandadoc_document_updateUpdate fields on an existing PandaDoc document that is still in draft status: name, recipients (add or update by id/email), merge fields, tokens, tags, metadata, pricing tables, tables, images, and texts.WriteUpdate Document
Update fields on an existing PandaDoc document that is still in draft status: name, recipients (add or update by id/email), merge fields, tokens, tags, metadata, pricing tables, tables, images, and texts. The document must not be sent, completed, or otherwise locked (a 423 is returned if the document is locked). Returns no content on success.
- Idempotent
Inputs
idstringrequired- The unique id of the document to update.
fieldsobject- Object mapping merge field names to {"value": ...} objects to update field values.
imagesarray- Array of {name, urls} objects to replace image blocks by name.
metadataobject- Arbitrary key-value data to associate with the document. Existing keys are updated, new keys are added.
namestring- New name for the document.
pricing_tablesarray- Array of pricing table objects to update pricing table blocks by name.
recipientsarray- Array of recipient objects. If id is passed, an existing recipient is updated; if only email is passed, a new recipient is added to CC.
tablesarray- Array of table objects to update table blocks by name.
tagsarray- Array of string tags to mark the document with.
textsarray- Array of {name, data} objects to replace text blocks by name.
tokensarray- Array of {name, value} objects used to create or update document variables.
pandadoc_notarization_request_createCreate a notarization request to connect with a notary and complete online notarizations for signers.WriteCreate Notarization Request
Create a notarization request to connect with a notary and complete online notarizations for signers. Only supports documents in draft status. Requires the Notary On-Demand or Notary add-on. At least one invitee (with email) is required. Optionally assign an in-house notary (must be ACTIVE) with a scheduled time. After the call, invitees receive an email invitation unless notifications are disabled; the notarization_link is also returned in the response for direct sharing.
Inputs
document_idstringrequired- ID of the document (must be in draft status) to send for notarization.
inviteesarrayrequired- List of invitees for the notarization session. Each object requires 'email' and may include 'first_name' and 'last_name'. At least one invitee is required.
disable_invitees_notificationsboolean- If true, disables all notifications for invitees, including the invitation email. Useful when using alternative delivery methods for the notarization_link.default
false invitation_messagestring- Optional message included in the invitation email sent to invitees.
notary_idstring- ID of an ACTIVE notary to assign for an in-house (bring-your-own-notary) notarization request. If omitted, signers connect with an available on-demand commissioned notary instead. When provided, notary_scheduled_at is also required.
notary_messagestring- Optional custom message for the notary, included in their invitation email. Only used when notary_id is provided.
notary_scheduled_atstring- ISO 8601 timestamp for the scheduled in-house notarization session. Required if notary_id is provided.
pandadoc_quote_updateUpdate a PandaDoc integration quote attached to a document.WriteQuote Update
Update a PandaDoc integration quote attached to a document. Sections and their items are order-authoritative: passing 'sections' replaces the full list of sections in the order given (omitted existing sections are removed), and each section's 'items' array replaces that section's full item list (omitted existing items are removed). Include the 'id' of an existing section/item to update it in place; omit or use an unknown id to create a new one. Returns the updated quote with computed totals.
- Idempotent
Inputs
document_idstringrequired- The ID of the document the quote belongs to.
quote_idstringrequired- The ID of the quote to update.
currencystring- ISO 4217 currency code for the quote (e.g. USD).
sectionsarray- Full ordered list of quote sections. This REPLACES all existing sections - any existing section not included here will be removed. Each section object may include: id (UUID of an existing section to update, or omit/use unknown to create new), name, summary (same shape as the top-level Summary field), items (full ordered list of section line items - same replace semantics as sections, see PandaDoc integration quote item schema for item fields like sku, name, qty, price, discounts, taxes), and settings ({optional, selected, selection_type}). Passed through as-is to the PandaDoc API.
settingsobject- Quote-level settings, e.g. selection_type ('single', 'multiple', or 'custom') describing how sections can be selected. Passed through as-is to the PandaDoc API.
summaryobject- Quote-level summary settings: custom_columns (map of string->string), discounts/fees/taxes (maps keyed by an arbitrary label, each value an object with 'type' (percent|flat|value) and numeric 'value'). Passed through as-is to the PandaDoc API.
pandadoc_template_createCreate a new PandaDoc template, either as an empty (blank) template or by importing a PDF from a publicly accessible HTTPS URL.WriteCreate Template
Create a new PandaDoc template, either as an empty (blank) template or by importing a PDF from a publicly accessible HTTPS URL. Optionally set a name, destination folder, owner, custom metadata, and initial token (variable) values. If a source url is provided, PandaDoc processes the PDF asynchronously; poll pandadoc_template_get_status with the returned id to check when the template reaches the 'template.PROCESSED' state.
Inputs
fieldsstring- Additional field to include in the response. Currently only 'content_date_modified' is supported.one of
content_date_modified folder_uuidstring- The ID of the folder where the created template should be stored.
metadataobject- Arbitrary key-value data to associate with the template. Returned in subsequent template details requests. Example: {"my_favorite_pet": "Panda"}.
namestring- The name of the template.
owner_emailstring- Email address of the user to set as the template's owner. Do not combine with owner_membership_id.
owner_membership_idstring- Membership ID of the user to set as the template's owner. Do not combine with owner_email.
tokensarray- Create and initialize CUSTOM template variables (tokens) with initial values. Each item is {"name": string, "value": string}. Predefined template variables are read-only. Example: [{"name":"Favorite.Pet","value":"Panda"}].
urlstring- Secure (HTTPS) and publicly accessible URL to a PDF document to import as the template's content. If omitted, an empty (blank) template is created.
pandadoc_template_create_editing_sessionCreate a new editing session for the PandaDoc Embedded Editor on a template.WriteCreate Template Editing Session
Create a new editing session for the PandaDoc Embedded Editor on a template. Returns an E-Token (token field) that is required to open the template in the embedded editor. Only one active session is allowed per user-template pair; creating a new session invalidates the previous one. A maximum of 250 sessions can be created for a single template per week.
Inputs
emailstringrequired- Email address of the user to create the editing session for.
idstringrequired- The id of the template to create an editing session for.
lifetimeinteger- Lifetime of the E-Token in seconds. Must be between 60 and 86400. Defaults to 3600 (1 hour).default
3600
pandadoc_template_duplicateCreate a copy of a PandaDoc template within the same workspace.WriteDuplicate Template
Create a copy of a PandaDoc template within the same workspace. Optionally provide a custom name for the duplicate; if omitted, a name is auto-generated from the source template. Returns the id, name, and creation date of the new template.
Inputs
idstringrequired- The id of the template to duplicate.
namestring- Custom name for the duplicated template. When omitted or empty, a name is auto-generated from the source template (e.g. 'Copy of Sample Template'). Maximum 255 characters.
pandadoc_template_folder_createCreate a new folder to store PandaDoc templates.WriteCreate Templates Folder
Create a new folder to store PandaDoc templates. Optionally nest it inside a parent folder by UUID. Returns the created folder's uuid, name, and date_created.
Inputs
namestringrequired- Name for the new templates folder.
parent_uuidstring- UUID of the parent folder to create this folder inside of. Omit to create the folder in the root folder.
pandadoc_template_folder_renameRename a templates folder in PandaDoc by its UUID.WriteRename Templates Folder
Rename a templates folder in PandaDoc by its UUID. Returns the updated folder object with uuid, name, and date_created.
- Idempotent
Inputs
idstringrequired- The UUID of the templates folder to rename.
namestringrequired- The new name to assign to the templates folder.
pandadoc_template_settings_updateUpdate the settings for a PandaDoc template.WriteUpdate Template Settings
Update the settings for a PandaDoc template. Currently only the document language setting is supported. Returns the updated template settings.
- Idempotent
Inputs
languagestringrequired- Document language code to set for the template, e.g. 'en-US', 'fr-FR', 'de-DE'.one of
en-USfr-FRit-ITes-ESnl-NLde-DEpt-BRpt-PTpl-PLsv-SEcs-CZda-DKel-GRhu-HUnb-NOro-RObg-BG template_idstringrequired- Unique identifier of the template to update settings for.
pandadoc_template_updateUpdate a PandaDoc template.WriteTemplate Update
Update a PandaDoc template. Currently supports updating template variables (tokens) and managing template roles. The template must be in the 'template.PROCESSED' status (check with pandadoc_template_get_status first). Passing 'roles' replaces the full set of template roles in a single request: items with an existing role id update that role (name, signing_order), items without an id create a new role, and existing roles whose id is not included are deleted. Preassigned contacts/contact groups on roles are preserved on update and removed together with their role on deletion.
- Idempotent
Inputs
idstringrequired- The ID of the template to update.
rolesarray- Replace the full set of template roles. Items with an existing 'id' are updated (name, signing_order); items without an 'id' are created as new roles; existing roles whose id is not present in this list are deleted. Role names must be unique within the template. Example: [{"id":"BqL3PVsB2tPLfaSqUiQQRf","name":"Client","signing_order":1},{"name":"Manager","signing_order":2}].
tokensarray- Create or set values for CUSTOM template variables (tokens). Each item is {"name": string, "value": string}. Predefined template variables are read-only and any attempt to change them is ignored. Example: [{"name":"Favorite.Pet","value":"Panda"}].
pandadoc_catalog_item_deletePermanently delete a product catalog item from PandaDoc by its item UUID.DestructiveDelete Catalog Item
Permanently delete a product catalog item from PandaDoc by its item UUID. This action cannot be undone.
- Idempotent
Inputs
item_uuidstringrequired- The UUID of the catalog item to delete.
pandadoc_contact_deletePermanently delete a PandaDoc contact by its id.DestructiveDelete Contact
Permanently delete a PandaDoc contact by its id. This action cannot be undone. Returns no content on success.
- Idempotent
Inputs
idstringrequired- The unique identifier of the contact to delete.
pandadoc_document_attachment_deletePermanently delete an attachment from a PandaDoc document by its attachment ID.DestructiveDelete Document Attachment
Permanently delete an attachment from a PandaDoc document by its attachment ID. This does not delete the document itself, only the attachment. Returns no content on success.
- Idempotent
Inputs
attachment_idstringrequired- The attachment UUID to delete.
idstringrequired- The document UUID that owns the attachment.
pandadoc_document_deletePermanently delete a PandaDoc document by ID.DestructiveDelete Document
Permanently delete a PandaDoc document by ID. This is a destructive operation and cannot be undone. Returns no content on success.
- Idempotent
Inputs
idstringrequired- The ID of the document to delete.
pandadoc_document_linked_object_deleteRemove a link between a PandaDoc document and a CRM entity.DestructiveDelete Linked Object
Remove a link between a PandaDoc document and a CRM entity. This does not delete the CRM entity itself, only the link record.
- Idempotent
Inputs
idstringrequired- The UUID of the document that owns the linked object.
linked_object_idstringrequired- The id of the linked object (link id) to delete.
pandadoc_document_recipient_deleteRemove a recipient from a PandaDoc document.DestructiveDelete Document Recipient
Remove a recipient from a PandaDoc document. Requires the 'Can Manage Recipients' permission. Removing a signer is only possible while the document is in the 'Draft' status and unassigns all fields associated with that signer. Removing a CC recipient is allowed in any status except 'Expired' or 'Declined', and revokes their access.
- Idempotent
Inputs
document_idstringrequired- The UUID of the document the recipient belongs to.
recipient_idstringrequired- The UUID of the recipient to remove. This is different from the recipient's contact ID; retrieve it via the Document Details endpoint.
pandadoc_document_section_deleteDelete a section (bundle) from a PandaDoc document.DestructiveDelete Document Section
Delete a section (bundle) from a PandaDoc document.
- Idempotent
Inputs
document_idstringrequired- The ID of the document the section belongs to.
section_idstringrequired- The ID of the section to delete.
pandadoc_notarization_request_deleteDelete a notarization request.DestructiveDelete Notarization Request
Delete a notarization request. Once deleted it cannot be restored. Only requests in status SENT, WAITING_FOR_NOTARY, or INCOMPLETE can be deleted; any other status returns a 400 Bad Request. By default all invitees receive an email notification about the deletion.
- Idempotent
Inputs
session_request_idstringrequired- The unique identifier (UUID) of the notarization request to delete.
pandadoc_template_deletePermanently delete a PandaDoc template by id.DestructiveDelete Template
Permanently delete a PandaDoc template by id. This action cannot be undone. Returns no content on success (204).
- Idempotent
Inputs
idstringrequired- The id of the template to delete.
No tools match.