PandaDoc integration: operations for AI agents
PandaDoc connects to Type.com as an integration. This page lists the 126 operations documented for Claude and Codex in Type.com: 53 read, 56 write, 17 destructive.
About PandaDoc
PandaDoc offers document creation, e-signatures, and workflow automation, helping sales teams and businesses streamline proposals, contracts, and agreement processes
Categories: Documents & Forms
How to connect PandaDoc to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
126 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
126 operations listed.
OAuth 2.0 Authentication
- Write
Create/Refresh Access Token
Create or refresh an access token to make requests on behalf of a user. This endpoint is used to obtain an accesstoken and refreshtoken for the first time, and to refresh the accesstoken when it expires. This endpoint is part of OAuth 2.0 implementation.
Documents
- Read
List Documents
This endpoint will let you list and search for the documents. Here you can find how to filter, search and order documents.
- Read
Document Status
It is useful to request document status to ensure a document is in the expected state before calling additional API methods.
- Read
Document eSign disclosure
Retrieves the current version of eSign disclosure text for a specified document.
- Read
Document Details
Return detailed data about a document. Use Document Status for getting just a basic info and status. Get details about a document by its id.
- Read
Document Download
Download documents as a PDF. ❗️ Downloading completed and signed documents To download completed and signed documents, you should use the Download Protected Document endpoint instead. See the How to download a completed document guide for details.
- Read
Download 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
- Read
[Beta] DOCX Export Task
📘 This endpoint returns the current state of a DOCX export task for a document. The endpoint supports downloading only multiple files if the document contains several sections. Downloading as a single file in this case is not possible.
- Write
Create Document
Create from a template See the Create document from template tutorial for details on how to use this endpoint, as well as a sample template. Create from a URL See the Create from public PDF guide for info about roles and fields, as well as PDF examples.
- Write
Create Document from File Upload
Create from an upload See the Create from PDF tutorial for the usage specifics and sample PDF files. Note: A file you upload is not stored in your PandaDoc account, so you have to upload it with every request.
- Write
Update Document
Use the PATCH method to update a PandaDoc document. 🚧 Document status You can only update a document in the Draft status (document.draft).
- Write
Document Status Change
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.
- Write
Document Status Change with Upload
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.
- Write
Move 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.
- Write
Send 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.
- Write
Create 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.
- Write
Create Document Session for Embedded Sign
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.
- Write
Update document ownership
This operation allows transferring the ownership of a document to another user by specifying the document ID and membership ID.
- Write
Transfer all documents ownership
This method transfers ownership of all documents from one member to another.
- Write
Document move to folder
This operation allows you to move a document to a folder by specifying the document ID and folder ID.
- Write
Append Content Library Item to a document
Appends a Content Library Item (CLI) to a document and provides a name mapping for its content blocks.
- Write
[Beta] Create DOCX Export Task
⏱️ Export as DOCX is a non-blocking (asynchronous) operation The document generation process may take some time. With a successful request, you receive a response with task ID, status created and document id.
- Destructive
Delete documents (bulk)
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.
- Destructive
Delete Document
Delete a document by ID.
Document Reminders
- Read
Document Auto Reminder Settings
Retrieves the current auto reminder configuration for a specified document.
- Read
Document Auto 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.
- Write
Update Document Auto 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.
- Write
Send Manual Reminder
Sends manual reminders to one or more recipients of a specified document.
Document Link to CRM
- Read
List Documents by Linked Object
Get a list of documents connected to a linked object - an entity from an integration.
- Read
List Linked Objects
Get a list of linked objects for the document.
- Write
Create 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.
- Destructive
Delete Linked Object
Delete a linked object associated with a document.
Document Attachments
- Read
List Document Attachments
Returns a list of attachments associated with a specified document.
- Read
Document Attachment Details
Returns details of the specific document's attachment.
- Read
Download Document Attachment
Download an attachment by ID.
- Write
Create Document Attachment
Creates an attachment for a particular document
- Write
Create Document Attachment From Upload
Creates an attachment for a particular document
- Destructive
Delete Document Attachment
Deletes an attachment from the document.
Document Fields
- Read
List Document Fields
Return the list of fields for a particular document.
- Write
Create 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.
- Write
Update Document Fields Assignment
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.
Document Audit Trail
- Read
List 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.
Document Settings
- Read
Get document settings
Retrieves the settings for a specified document.
- Write
Update document settings
Updates the settings for a specified document.
Document Recipients
- Write
Add 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.
- Write
Update 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.
- Write
Change Signer (Reassign Document Recipient)
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.
- Destructive
Delete 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).
Document Sections (Bundles)
- Read
List Document Sections
Retrieve information about the sections within a document.
- Read
Document Section Upload Status
Receive the upload status of the document and sections by their uploadid. 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 sectionsuuid.
- Read
Document Section Details
Receive information about each section.
- Write
Create 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.
- Write
Create Document Section from File Upload
With this endpoint, you can add a new section to an existing PandaDoc document (create a bundle). The section is created from a file you upload. The file can be a PDF, DocX, or RTF. 📘 We've prepared two samples that you can use to test the request.
- Destructive
Delete Document Section
Removes selected section from the document.
Content Library Items
- Read
List Content Library Item
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.
- Read
Content Library Item Status
Requesting the CLI status helps verify that a CLI is in the expected state before invoking additional API methods.
- Read
Content Library Item Details
Retrieve detailed information about a specific content library item using its ID.
- Write
Create 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.
- Write
Create Content Library Item from File Upload
This asynchronous endpoint allows users to create a new CLI by uploading a file. The uploaded file is processed in the background to generate the CLI. The maximum allowable file size for upload is 100 MB. Field tags and form fields are not supported yet.
Templates
- Read
List Templates
Retrieves a list of templates. You can filter results by a search query, tags, or fields.
- Read
Template Details
Get details about a template by id. Details include: - Basic template information (name, author, etc) - Roles - All fields with values - All tokens with values - Pricing information (pricing tables, products, quotes) - Template metadata - Template tags - Content placeholders - M…
- Read
Template Status
Available Template Statuses The following is a complete list of all possible template statuses returned: | Template Status | Status Description | | :------------------- | :-----------------------------------------------------------------------------------------------------------…
- Write
Create Template
This operation allows you to create a new template by providing the necessary template details.
- Write
Create Template from File Upload
This asynchronous endpoint allows users to create a new template by uploading a file. The uploaded file is processed in the background to generate the template. The maximum allowable file size for upload is 100 MB. Field tags and form fields are not supported yet.
- Write
Duplicate Template
Duplicate Template Creates a copy of a template within the same workspace. 📘 Permissions Requires canreadtemplates and canduplicatetemplates permissions. Duplicating templates owned by other users additionally requires canduplicateanytemplate.
- Write
Template Update
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).
- Write
Create 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.
- Destructive
Delete Template
Delete a template
Template Settings
- Read
Get template settings
Retrieves the settings for a specified template. Only the language field is currently supported.
- Write
Update template settings
Updates the settings for a specified template. Only the language field is currently supported.
- Destructive
Update 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.
Forms
- Read
List Forms
Retrieve a paginated list of forms with optional filtering and sorting options.
Folders
- Read
List Documents Folders
Get the list of folders which contain Documents in your account. 📘 The root folder is not listed in the response. For the full list of folder operations and their limitations, see Organize Documents and Folders.
- Read
List Templates 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.
- Write
Create Documents Folder
Create a new folder to store your documents. For the full list of folder operations and their limitations, see Organize Documents and Folders.
- Write
Create Templates Folder
Create a new folder to store your templates. For the full list of folder operations and their limitations, see Organize Templates and Folders.
- Destructive
Rename Documents Folder
Rename Documents Folder. For the full list of folder operations and their limitations, see Organize Documents and Folders.
- Destructive
Rename Templates Folder
Rename a templates folder. For the full list of folder operations and their limitations, see Organize Templates and Folders.
API Logs
- Read
List API Log
Get the list of all logs within the selected workspace.\ Optionally filter by date, page, and of items per page.
- Read
API Log Details
Returns details of the specific API log event.
Contacts
- Read
List contacts
This method returns a list of contacts associated with a workspace.
- Read
Contact Details
Returns contact details by its ID.
- Write
Create contact
This method adds a contact into a contacts list.
- Write
Update Contact
This method updates a contact details.
- Destructive
Delete Contact
This method deletes a contact.
Members
- Read
List 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…
- Read
Current Member Details
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.
- Read
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.
- Write
Create Member Token
🚧 This endpoint is only exposed upon request. Please reach out to your Account Manager to get access. 📘 Make sure you're using Public API keys generated by Org Admin, otherwise you'll receive a 403 response.
Webhook subscriptions
- Read
List Webhook Subscriptions
This operation fetches a paginated list of webhook subscriptions.
- Read
Webhook Subscription Details
Get webhook subscription by uuid
- Write
Create Webhook Subscription
This operation creates a new webhook subscription by specifying its details.
- Write
Update Webhook Subscription
This operation updates the details of a webhook subscription.
- Destructive
Delete Webhook Subscription
This operation deletes a specific webhook subscription identified by its UUID.
Webhook events
- Read
List Webhook Events
This operation retrieves a paginated list of all webhook events.
- Read
Webhook Event Details
This operation fetches detailed information about a specific webhook event using its unique identifier.
Notary
- Read
List 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
- Read
List 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.
- Read
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.
- Write
Create 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.
- Destructive
Delete 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', 'WAITINGFORNOTARY' or 'INCOMPLETE'.
Product catalog
- Read
List Catalog Items Search
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.
- Read
Catalog Item Details
Get catalog item.
- Write
Create Catalog Item
Create a new catalog item.
- Write
Update Catalog Item
Update catalog item.
- Destructive
Delete Catalog Item
Delete catalog item.
Approval Workflows
- Read
[Beta] Get Submit for approval configuration
Retrieves the Submit for approval configuration on a template. Learn more about approval workflows.
- Destructive
[Beta] Update Template Approval Workflow
Creates or replaces the Submit for approval configuration on a template. A template has at most one configuration; this operation always writes the full desired end-state. steps lists the stages in the approval order and must contain at least one stage.
Privacy settings
- Read
[Beta] Workspace Privacy Settings Details
Returns the privacy settings currently in effect for a workspace in your organization. You must be an organization admin. Organization admin is an organization-wide role and is separate from workspace admin. Workspace admin alone is not enough for this endpoint.
- Write
[Beta] Update Workspace Privacy Settings
Updates one or more AI privacy settings for a workspace in your organization. This is a PATCH: include only the fields you want to change. Fields you omit keep their current values. Unknown properties are ignored. You must be an organization admin.
Quotes
- Write
[Beta] Update Multiple Quotes
This operation updates multiple quotes within a single document in one request — the batch variant of Quote update .
- Destructive
Quote update
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).
User and Workspace management
- Read
List Workspaces
Get a list of all the active workspaces in the organization.
- Read
List 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.
- Read
Get User Details 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.
- Write
Create 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.
- Write
Deactivate Workspace
Deactivate the workspace, remove all the members from it and make it unavailable.
- Write
Create 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.
- Write
Add Member to Workspace
Add an existing user to a workspace. - You must be an organization admin or a workspace admin to add members.
- Write
Change Member Role in Workspace
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.
- Write
Create API Key
Generate a new API key for the workspace. Check out API Key Authentication article for detailed API Keys description. 📘 - Only an Org Admin can generate an API keys. - To make another user a key's owner, pass userid of this user.
- Write
[Beta] Update Workspace
Update a workspace's name and branding. - You need to be an Org Admin to update a workspace.
- Destructive
Remove Member from Workspace
This operation removes a specified member from a workspace by providing the workspace ID and member ID.
Communication Preferences
- Read
Recent SMS Opt-out
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 timestampfrom and timestampto.
No operations match.
See How connections work for access and permissions, or browse all integrations.