pandadoc
Module pandadoc
API
Definitions
ballerinax/pandadoc Ballerina library
Overview
PandaDoc is a document automation platform for creating, sending, e-signing and tracking proposals, quotes and contracts from reusable templates.
The PandaDoc connector lets Ballerina applications work with the PandaDoc Public API (version 8.20.0). It covers documents, templates, content library items, folders, contacts, recipients, webhooks, notarization, the product catalog, quotes and workspace administration.
Key features
- Create documents from templates or uploaded files, send them for signature and track their status
- Manage templates, content library items and the folders that organize them
- Add, update and reassign recipients, fields, attachments and linked objects on documents
- Subscribe to document and template events through webhooks and read webhook event history
- Administer workspaces, users, members and API keys, and manage the product catalog and quotes
Setup guide
To use the PandaDoc connector you need a PandaDoc account with API access. If you do not have one, sign up at PandaDoc.
Option 1: API key
- Sign in to PandaDoc and open the Developer Dashboard from the account menu.
- Open the API Keys page and generate a key for the Production (or Sandbox) environment.
- Copy the key. Requests authenticate with the header value
API-Key <your-key>.
Option 2: OAuth 2.0
- In the Developer Dashboard, register an application and note its client ID and client secret.
- Add your redirect URI to the application settings.
- Send the user to
https://app.pandadoc.com/oauth2/authorize?client_id=<client-id>&redirect_uri=<redirect-uri>&scope=read%20write&response_type=code. - Exchange the returned authorization code at
https://api.pandadoc.com/oauth2/access_tokento obtain an access token and a refresh token.
Quickstart
To use the pandadoc connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/pandadoc;
Step 2: Create a new connector instance
Create a Config.toml file with your API key.
apiKey = "<API_KEY>"
Then create a pandadoc:Client with the API key.
configurable string apiKey = ?; final pandadoc:Client pandadoc = check new ({auth: {authorization: "API-Key " + apiKey}});
Step 3: Invoke the connector operation
Use the client to list the templates of your workspace.
public function main() returns error? { pandadoc:TemplateListResponse _ = check pandadoc->listTemplates(); }
Step 4: Run the Ballerina application
bal run
Examples
The PandaDoc connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Contract send workflow - Create a document from a template, wait until it is ready, optionally send it for signature and read back its details.
- Webhook subscription setup - Make sure a webhook subscription exists, read it back and optionally remove it.
Clients
pandadoc: Client
Client for the PandaDoc API. Create, send and track documents, templates, forms and e-signatures.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.pandadoc.com" - URL of the target service
createAccessToken
function createAccessToken(AccessTokenRequest payload, map<string|string[]> headers) returns OAuth2AccessTokenResponse|errorCreate/Refresh Access Token
Parameters
- payload AccessTokenRequest - Grant type and credentials used to create or refresh an access token
Return Type
listDocuments
function listDocuments(map<string|string[]> headers, *ListDocumentsQueries queries) returns DocumentListResponse|errorList Documents
Parameters
- queries *ListDocumentsQueries - Queries to be sent with the request
Return Type
createDocument
function createDocument(DocumentCreateRequest payload, map<string|string[]> headers, *CreateDocumentQueries queries) returns DocumentCreateResponse|errorCreate Document
Parameters
- payload DocumentCreateRequest - Document details, recipients, and content used to create a document
- queries *CreateDocumentQueries - Queries to be sent with the request
Return Type
bulkDeleteDocuments
function bulkDeleteDocuments(BulkDeleteDocumentsRequest payload, map<string|string[]> headers) returns BulkDeleteDocumentsResponse|errorDelete documents (bulk)
Parameters
- payload BulkDeleteDocumentsRequest - List of document IDs to delete in bulk
Return Type
- BulkDeleteDocumentsResponse|error - OK — documents were deleted. Response lists deleted document IDs
createDocumentFromUpload
function createDocumentFromUpload(CreateDocumentFromUploadRequest payload, map<string|string[]> headers, *CreateDocumentFromUploadQueries queries) returns DocumentCreateResponse|errorCreate Document from File Upload
Parameters
- payload CreateDocumentFromUploadRequest - Uploaded file and document creation parameters
- queries *CreateDocumentFromUploadQueries - Queries to be sent with the request
Return Type
getDocumentStatus
function getDocumentStatus(string id, map<string|string[]> headers) returns DocumentStatusResponse|errorDocument Status
Parameters
- id string - Specify document ID
Return Type
deleteDocument
Delete Document
Parameters
- id string - Document ID
Return Type
- error? - No content
updateDocument
function updateDocument(string id, DocumentUpdateRequest payload, map<string|string[]> headers) returns error?Update Document
Parameters
- id string - Document ID
- payload DocumentUpdateRequest - Document fields to update, such as recipients, tokens, and metadata
Return Type
- error? - No content
getDocumentAutoReminderSettings
function getDocumentAutoReminderSettings(string documentId, map<string|string[]> headers) returns AutoReminders|errorDocument Auto Reminder Settings
Parameters
- documentId string - The UUID of the document
Return Type
- AutoReminders|error - Auto reminder settings retrieved successfully
updateDocumentAutoReminderSettings
function updateDocumentAutoReminderSettings(string documentId, UpdateDocumentAutoRemindersRequest payload, map<string|string[]> headers) returns UpdateDocumentAutoRemindersResponse|errorUpdate Document Auto Reminder Settings
Parameters
- documentId string - The UUID of the document
- payload UpdateDocumentAutoRemindersRequest - Auto reminder settings to apply to the document
Return Type
- UpdateDocumentAutoRemindersResponse|error - Auto reminder settings updated successfully
getDocumentAutoReminderStatus
function getDocumentAutoReminderStatus(string documentId, map<string|string[]> headers) returns DocumentAutoRemindersResponse|errorDocument Auto Reminder Status
Parameters
- documentId string - The UUID of the document
Return Type
- DocumentAutoRemindersResponse|error - Auto reminder status retrieved successfully
getDocumentESignDisclosure
function getDocumentESignDisclosure(string documentId, map<string|string[]> headers) returns DocumentESignDisclosure|errorDocument eSign disclosure
Parameters
- documentId string - The UUID of the document
Return Type
- DocumentESignDisclosure|error - ESign disclosure text retrieved successfully
changeDocumentStatus
function changeDocumentStatus(string id, DocumentStatusChangeRequest payload, map<string|string[]> headers) returns error?Document Status Change
Parameters
- id string - Specify document ID
- payload DocumentStatusChangeRequest - New status to set on the document and optional notification settings
Return Type
- error? - No content
changeDocumentStatusWithUpload
function changeDocumentStatusWithUpload(string id, ChangeDocumentStatusWithUploadRequest payload, map<string|string[]> headers) returns error?Document Status Change with Upload
Parameters
- id string - Specify document ID
- payload ChangeDocumentStatusWithUploadRequest - Uploaded file and the new document status parameters
Return Type
- error? - No content
revertDocumentToDraft
function revertDocumentToDraft(string id, map<string|string[]> headers) returns DocumentRevertToDraftResponse|errorMove Document to Draft
Parameters
- id string - Specify document ID
Return Type
- DocumentRevertToDraftResponse|error - Success response
getDocumentDetails
function getDocumentDetails(string id, map<string|string[]> headers) returns DocumentDetailsResponse|errorDocument Details
Parameters
- id string - Document ID
Return Type
sendDocument
function sendDocument(string id, DocumentSendRequest payload, map<string|string[]> headers) returns DocumentSendResponse|errorSend Document
Parameters
- id string - Document ID
- payload DocumentSendRequest - Message, subject, and delivery options used to send the document
Return Type
createDocumentEditingSession
function createDocumentEditingSession(string id, EditingSessionRequest payload, map<string|string[]> headers) returns DocumentEditingSessionResponse|errorCreate Document Editing Session
Parameters
- id string - Document ID
- payload EditingSessionRequest - Recipient and lifetime options for the document editing session
Return Type
- DocumentEditingSessionResponse|error - Document Editing Session created
createDocumentLink
function createDocumentLink(string id, DocumentCreateLinkRequest payload, map<string|string[]> headers) returns DocumentCreateLinkResponse|errorCreate Document Session for Embedded Sign
Parameters
- id string - Document ID
- payload DocumentCreateLinkRequest - Recipient and lifetime options for the embedded signing session
Return Type
downloadDocument
function downloadDocument(string id, map<string|string[]> headers, *DownloadDocumentQueries queries) returns Response|error?Document Download
Parameters
- id string - Specify document ID
- queries *DownloadDocumentQueries - Queries to be sent with the request
downloadProtectedDocument
function downloadProtectedDocument(string id, map<string|string[]> headers, *DownloadProtectedDocumentQueries queries) returns Response|error?Download Completed Document
Parameters
- id string - Specify document ID
- queries *DownloadProtectedDocumentQueries - Queries to be sent with the request
listDocumentsByLinkedObject
function listDocumentsByLinkedObject(map<string|string[]> headers, *ListDocumentsByLinkedObjectQueries queries) returns ListDocumentsByLinkedObjectsResponse|errorList Documents by Linked Object
Parameters
- queries *ListDocumentsByLinkedObjectQueries - Queries to be sent with the request
Return Type
listLinkedObjects
function listLinkedObjects(string id, map<string|string[]> headers) returns LinkedObjectListResponse|errorList Linked Objects
Parameters
- id string - Specify document ID
Return Type
- LinkedObjectListResponse|error - Success response
createLinkedObject
function createLinkedObject(string id, LinkedObjectCreateRequest payload, map<string|string[]> headers) returns LinkedObjectCreateResponse|errorCreate Linked Object
Parameters
- id string - Specify document ID
- payload LinkedObjectCreateRequest - Provider and entity details of the object to link to the document
Return Type
- LinkedObjectCreateResponse|error - Created
deleteLinkedObject
function deleteLinkedObject(string id, string linkedObjectId, map<string|string[]> headers) returns error?Delete Linked Object
Return Type
- error? - No content
listDocumentAttachments
function listDocumentAttachments(string id, map<string|string[]> headers) returns DocumentAttachmentResponse[]|errorList Document Attachments
Parameters
- id string - Document UUID
Return Type
- DocumentAttachmentResponse[]|error - OK
createDocumentAttachment
function createDocumentAttachment(string id, DocumentAttachmentRequest payload, map<string|string[]> headers) returns DocumentAttachmentResponse|errorCreate Document Attachment
Parameters
- id string - Document UUID
- payload DocumentAttachmentRequest - Source URL and name of the attachment to add to the document
Return Type
createDocumentAttachmentFromFileUpload
function createDocumentAttachmentFromFileUpload(string id, DocumentAttachmentCreateFromFile payload, map<string|string[]> headers) returns DocumentAttachmentResponse|errorCreate Document Attachment From Upload
Parameters
- id string - Document UUID
- payload DocumentAttachmentCreateFromFile - Uploads attachment to document by using Multipart Form Data
Return Type
getDocumentAttachmentDetails
function getDocumentAttachmentDetails(string id, string attachmentId, map<string|string[]> headers) returns DocumentAttachmentResponse|errorDocument Attachment Details
Return Type
deleteDocumentAttachment
function deleteDocumentAttachment(string id, string attachmentId, map<string|string[]> headers) returns error?Delete Document Attachment
Return Type
- error? - No Content
downloadDocumentAttachment
function downloadDocumentAttachment(string id, string attachmentId, map<string|string[]> headers) returns Response|errorDownload Document Attachment
listDocumentFields
function listDocumentFields(string id, map<string|string[]> headers) returns ListDocumentFieldsResponse|errorList Document Fields
Parameters
- id string - Document UUID
Return Type
createDocumentFields
function createDocumentFields(string id, CreateDocumentFieldsRequest payload, map<string|string[]> headers) returns CreateDocumentFieldsResponse|errorCreate Document Fields
Parameters
- id string - Document UUID
- payload CreateDocumentFieldsRequest - Fields to create on the document
Return Type
updateDocumentFieldsAssignment
function updateDocumentFieldsAssignment(string id, UpdateDocumentFieldsAssignmentRequest payload, map<string|string[]> headers) returns error?Update Document Fields Assignment
Parameters
- id string - Document UUID
- payload UpdateDocumentFieldsAssignmentRequest - A list of field assignment operations to apply to the document
Return Type
- error? - No content
listDocumentAuditTrail
function listDocumentAuditTrail(string documentId, map<string|string[]> headers, *ListDocumentAuditTrailQueries queries) returns DocumentAuditTrailResponse|errorList Document Audit Trail
Parameters
- documentId string - Unique identifier of the document to retrieve the audit trail for
- queries *ListDocumentAuditTrailQueries - Queries to be sent with the request
Return Type
- DocumentAuditTrailResponse|error - Successfully retrieved audit trail
getDocumentSettings
function getDocumentSettings(string documentId, map<string|string[]> headers) returns DocumentSettingsResponse|errorGet document settings
Parameters
- documentId string - Unique identifier of the document to retrieve settings for
Return Type
- DocumentSettingsResponse|error - Successfully retrieved document settings
updateDocumentSettings
function updateDocumentSettings(string documentId, UpdateDocumentSettingsRequest payload, map<string|string[]> headers) returns DocumentSettingsResponse|errorUpdate document settings
Parameters
- documentId string - Unique identifier of the document to update settings for
- payload UpdateDocumentSettingsRequest - Document settings to update
Return Type
- DocumentSettingsResponse|error - Successfully updated document settings
transferDocumentOwnership
function transferDocumentOwnership(string id, DocumentTransferOwnershipRequest payload, map<string|string[]> headers) returns error?Update document ownership
Parameters
- id string - Specify document ID
- payload DocumentTransferOwnershipRequest - New owner of the document
Return Type
- error? - No content
transferAllDocumentsOwnership
function transferAllDocumentsOwnership(DocumentTransferAllOwnershipRequest payload, map<string|string[]> headers) returns error?Transfer all documents ownership
Parameters
- payload DocumentTransferAllOwnershipRequest - Current and new owners for transferring all documents
Return Type
- error? - No content
moveDocumentToFolder
function moveDocumentToFolder(string id, string folderId, map<string|string[]> headers) returns error?Document move to folder
Return Type
- error? - No content
appendContentLibraryItemToDocument
function appendContentLibraryItemToDocument(string id, AppendCLIDataRequest payload, map<string|string[]> headers) returns AppendCLIDataResponse|errorAppend Content Library Item to a document
Parameters
- id string - Specify document id
- payload AppendCLIDataRequest - Content library item to append to the document and its variables
Return Type
addDocumentRecipient
function addDocumentRecipient(string id, DocumentRecipientCreateRequest payload, map<string|string[]> headers) returns DocumentRecipientResponse|errorAdd Document Recipient
Parameters
- id string - Document UUID
- payload DocumentRecipientCreateRequest - Details of the recipient to add to the document
Return Type
deleteDocumentRecipient
function deleteDocumentRecipient(string id, string recipientId, map<string|string[]> headers) returns error?Delete Document Recipient
Return Type
- error? - No content
editDocumentRecipient
function editDocumentRecipient(string id, string recipientId, EditDocumentRecipientBody payload, map<string|string[]> headers) returns error?Update Document Recipient
Parameters
- id string - Document UUID
- recipientId string - Recipient UUID
- payload EditDocumentRecipientBody - Recipient details to update
Return Type
- error? - No content
reassignDocumentRecipient
function reassignDocumentRecipient(string id, string recipientId, DocumentRecipientCreateRequest payload, map<string|string[]> headers) returns DocumentRecipientResponse|errorChange Signer (Reassign Document Recipient)
Parameters
- id string - Document UUID
- recipientId string - Recipient UUID
- payload DocumentRecipientCreateRequest - Replacement recipient details for the reassignment
Return Type
createManualReminder
function createManualReminder(string documentId, DocumentSendManualReminderRequest payload, map<string|string[]> headers) returns DocumentSendManualReminder200Response|errorSend Manual Reminder
Parameters
- documentId string - The UUID of the document
- payload DocumentSendManualReminderRequest - Recipients and customization options for the manual reminder
Return Type
- DocumentSendManualReminder200Response|error - Successfully processed reminder requests. Returns an array of objects, where each object details the outcome of the reminder delivery attempt for a specific recipient
listSections
function listSections(string documentId, map<string|string[]> headers) returns UploadSectionListResponse|errorList Document Sections
Parameters
- documentId string - Document ID
Return Type
uploadSection
function uploadSection(string documentId, UploadSectionRequestBody payload, map<string|string[]> headers, *UploadSectionQueries queries) returns UploadSectionResponse|errorCreate Document Section
Parameters
- documentId string - Document ID
- payload UploadSectionRequestBody - Template or file source and options for the new document section
- queries *UploadSectionQueries - Queries to be sent with the request
Return Type
uploadSectionFromFile
function uploadSectionFromFile(string documentId, UploadSectionWithUploadRequest payload, map<string|string[]> headers, *UploadSectionFromFileQueries queries) returns Response|errorCreate Document Section from File Upload
Parameters
- documentId string - Document ID
- payload UploadSectionWithUploadRequest - Uploaded file and options for the new document section
- queries *UploadSectionFromFileQueries - Queries to be sent with the request
getSectionUploadStatus
function getSectionUploadStatus(string documentId, string uploadId, map<string|string[]> headers) returns UploadSectionStatusResponse|errorDocument Section Upload Status
Return Type
getSectionDetails
function getSectionDetails(string documentId, string sectionId, map<string|string[]> headers) returns SectionInfoResponse|errorDocument Section Details
Return Type
- SectionInfoResponse|error - OK
deleteSection
function deleteSection(string documentId, string sectionId, map<string|string[]> headers) returns error?Delete Document Section
Return Type
- error? - No content
listContentLibraryItems
function listContentLibraryItems(map<string|string[]> headers, *ListContentLibraryItemsQueries queries) returns ContentLibraryItemListResponse|errorList Content Library Item
Parameters
- queries *ListContentLibraryItemsQueries - Queries to be sent with the request
Return Type
createContentLibraryItem
function createContentLibraryItem(ContentLibraryItemCreateFromUrlRequest payload, map<string|string[]> headers) returns ContentLibraryResponse|errorCreate Content Library Item
Parameters
- payload ContentLibraryItemCreateFromUrlRequest - Content library item name and source to create
Return Type
createContentLibraryItemFromUpload
function createContentLibraryItemFromUpload(CreateContentLibraryItemFromUploadRequest payload, map<string|string[]> headers) returns ContentLibraryResponse|errorCreate Content Library Item from File Upload
Parameters
- payload CreateContentLibraryItemFromUploadRequest - Uploaded file and content library item creation parameters
Return Type
getContentLibraryItemStatus
function getContentLibraryItemStatus(string id, map<string|string[]> headers) returns ContentLibraryResponse|errorContent Library Item Status
Parameters
- id string - Content Library Item ID
Return Type
getContentLibraryItemDetails
function getContentLibraryItemDetails(string id, map<string|string[]> headers) returns ContentLibraryItemResponse|errorContent Library Item Details
Parameters
- id string - Content Library Item ID
Return Type
listTemplates
function listTemplates(map<string|string[]> headers, *ListTemplatesQueries queries) returns TemplateListResponse|errorList Templates
Parameters
- queries *ListTemplatesQueries - Queries to be sent with the request
Return Type
createTemplate
function createTemplate(CreateTemplateFromUrlRequest payload, map<string|string[]> headers, *CreateTemplateQueries queries) returns TemplateCreateResponse|errorCreate Template
Parameters
- payload CreateTemplateFromUrlRequest - Template name, content source, and roles to create
- queries *CreateTemplateQueries - Queries to be sent with the request
Return Type
createTemplateWithUpload
function createTemplateWithUpload(CreateTemplateWithUploadRequest payload, map<string|string[]> headers, *CreateTemplateWithUploadQueries queries) returns TemplateCreateResponse|errorCreate Template from File Upload
Parameters
- payload CreateTemplateWithUploadRequest - Uploaded file and template creation parameters
- queries *CreateTemplateWithUploadQueries - Queries to be sent with the request
Return Type
duplicateTemplate
function duplicateTemplate(string id, TemplateDuplicateRequest payload, map<string|string[]> headers) returns TemplateDuplicateResponse|errorDuplicate Template
Parameters
- id string - Template ID
- payload TemplateDuplicateRequest - Optional payload with a custom name for the duplicated template
Return Type
- TemplateDuplicateResponse|error - Template duplicated successfully
getTemplateDetails
function getTemplateDetails(string id, map<string|string[]> headers) returns TemplateDetailsResponse|errorTemplate Details
Parameters
- id string - Template ID
Return Type
getTemplateStatus
function getTemplateStatus(string id, map<string|string[]> headers) returns TemplateStatusResponse|errorTemplate Status
Parameters
- id string - Template ID
Return Type
deleteTemplate
Delete Template
Parameters
- id string - Template ID
Return Type
- error? - No content
updateTemplate
function updateTemplate(string id, TemplateUpdateRequest payload, map<string|string[]> headers) returns error?Template Update
Parameters
- id string - Template ID
- payload TemplateUpdateRequest - Partial template update. All fields are optional
Return Type
- error? - No content
createTemplateEditingSession
function createTemplateEditingSession(string id, EditingSessionRequest payload, map<string|string[]> headers) returns TemplateEditingSessionResponse|errorCreate Template Editing Session
Parameters
- id string - Template ID
- payload EditingSessionRequest - Options for the template editing session
Return Type
- TemplateEditingSessionResponse|error - Template Editing Session created
getTemplateSettings
function getTemplateSettings(string templateId, map<string|string[]> headers) returns TemplateSettingsResponse|errorGet template settings
Parameters
- templateId string - Unique identifier of the template to retrieve settings for
Return Type
- TemplateSettingsResponse|error - Successfully retrieved template settings
updateTemplateSettings
function updateTemplateSettings(string templateId, UpdateTemplateSettingsRequest payload, map<string|string[]> headers) returns TemplateSettingsResponse|errorUpdate template settings
Parameters
- templateId string - Unique identifier of the template to update settings for
- payload UpdateTemplateSettingsRequest - Template settings to update
Return Type
- TemplateSettingsResponse|error - Successfully updated template settings
getTemplateShares
function getTemplateShares(string templateId, map<string|string[]> headers) returns TemplateSharesResponse|errorGet Template Sharing Settings
Parameters
- templateId string - Unique identifier of the Template to retrieve Shares for
Return Type
- TemplateSharesResponse|error - Successfully retrieved the Template's Shares
updateTemplateSharingSettings
function updateTemplateSharingSettings(string templateId, TemplateSharesRequest payload, map<string|string[]> headers) returns TemplateSharesResponse|errorUpdate Template Sharing Settings
Parameters
- templateId string - Unique identifier of the Template whose Shares are being replaced
- payload TemplateSharesRequest - Sharing settings to apply to the template
Return Type
- TemplateSharesResponse|error - Successfully replaced the Template's Shares
listForms
function listForms(map<string|string[]> headers, *ListFormsQueries queries) returns FormListResponse|errorList Forms
Parameters
- queries *ListFormsQueries - Queries to be sent with the request
Return Type
- FormListResponse|error - List of forms
listDocumentFolders
function listDocumentFolders(map<string|string[]> headers, *ListDocumentFoldersQueries queries) returns DocumentsFolderListResponse|errorList Documents Folders
Parameters
- queries *ListDocumentFoldersQueries - Queries to be sent with the request
Return Type
- DocumentsFolderListResponse|error - List of documents folders
createDocumentFolder
function createDocumentFolder(DocumentsFolderCreateRequest payload, map<string|string[]> headers) returns DocumentsFolderCreateResponse|errorCreate Documents Folder
Parameters
- payload DocumentsFolderCreateRequest - Name and parent of the documents folder to create
Return Type
- DocumentsFolderCreateResponse|error - Documents folder created
renameDocumentFolder
function renameDocumentFolder(string id, DocumentsFolderRenameRequest payload, map<string|string[]> headers) returns DocumentsFolderRenameResponse|errorRename Documents Folder
Parameters
- id string - The UUID of the folder that you are renaming
- payload DocumentsFolderRenameRequest - New name of the documents folder
Return Type
listTemplateFolders
function listTemplateFolders(map<string|string[]> headers, *ListTemplateFoldersQueries queries) returns TemplatesFolderListResponse|errorList Templates Folders
Parameters
- queries *ListTemplateFoldersQueries - Queries to be sent with the request
Return Type
createTemplateFolder
function createTemplateFolder(TemplatesFolderCreateRequest payload, map<string|string[]> headers) returns TemplatesFolderCreateResponse|errorCreate Templates Folder
Parameters
- payload TemplatesFolderCreateRequest - Name and parent of the templates folder to create
Return Type
renameTemplateFolder
function renameTemplateFolder(string id, TemplatesFolderRenameRequest payload, map<string|string[]> headers) returns TemplatesFolderRenameResponse|errorRename Templates Folder
Parameters
- id string - The UUID of the folder which you are renaming
- payload TemplatesFolderRenameRequest - New name of the templates folder
Return Type
listLogs
function listLogs(map<string|string[]> headers, *ListLogsQueries queries) returns APILogListResponse|errorList API Log
Parameters
- queries *ListLogsQueries - Queries to be sent with the request
Return Type
- APILogListResponse|error - OK
Deprecated
getLogDetails
API Log Details
Parameters
- id string - Log event id
Return Type
Deprecated
listLogsV2
function listLogsV2(map<string|string[]> headers, *ListLogsV2Queries queries) returns APILogListResponse|errorList API Log (v2)
Parameters
- queries *ListLogsV2Queries - Queries to be sent with the request
Return Type
- APILogListResponse|error - OK
getLogDetailsV2
function getLogDetailsV2(string id, map<string|string[]> headers) returns APILogDetailsResponse|errorAPI Log Details (v2)
Parameters
- id string - Log event id
Return Type
listContacts
function listContacts(map<string|string[]> headers, *ListContactsQueries queries) returns ContactListResponse|errorList contacts
Parameters
- queries *ListContactsQueries - Queries to be sent with the request
Return Type
- ContactListResponse|error - OK
createContact
function createContact(ContactCreateRequest payload, map<string|string[]> headers) returns ContactDetailsResponse|errorCreate contact
Parameters
- payload ContactCreateRequest - Contact details used to create the contact
Return Type
getContactDetails
function getContactDetails(string id, map<string|string[]> headers) returns ContactDetailsResponse|errorContact Details
Parameters
- id string - Contact id
Return Type
deleteContact
Delete Contact
Parameters
- id string - Contact id
Return Type
- error? - OK
updateContact
function updateContact(string id, ContactUpdateRequest payload, map<string|string[]> headers) returns ContactDetailsResponse|errorUpdate Contact
Return Type
listMembers
function listMembers(map<string|string[]> headers) returns MemberListResponse|errorList Members
Return Type
- MemberListResponse|error - OK
getCurrentMemberDetails
function getCurrentMemberDetails(map<string|string[]> headers) returns MemberDetailsResponse|errorCurrent Member Details
Return Type
getMemberDetails
function getMemberDetails(string id, map<string|string[]> headers) returns MemberDetailsResponse|errorMember Details
Parameters
- id string - Membership id
Return Type
createMemberToken
function createMemberToken(string memberId, CreateMemberTokenRequest payload, map<string|string[]> headers) returns CreateMemberTokenResponse|errorCreate Member Token
Parameters
- memberId string - Member id
- payload CreateMemberTokenRequest - Token creation options for the member
Return Type
listWebhookSubscriptions
function listWebhookSubscriptions(map<string|string[]> headers) returns WebhookSubscriptionListResponse|errorList Webhook Subscriptions
Return Type
- WebhookSubscriptionListResponse|error - List webhook subscriptions
createWebhookSubscription
function createWebhookSubscription(WebhookSubscriptionCreateRequest payload, map<string|string[]> headers) returns WebhookSubscriptionItemResponse|errorCreate Webhook Subscription
Parameters
- payload WebhookSubscriptionCreateRequest - Name, endpoint, triggers, and payload options of the webhook subscription
Return Type
- WebhookSubscriptionItemResponse|error - Webhook subscription created
getWebhookSubscriptionDetails
function getWebhookSubscriptionDetails(string id, map<string|string[]> headers) returns WebhookSubscriptionItemResponse|errorWebhook Subscription Details
Parameters
- id string - Webhook subscription uuid
Return Type
- WebhookSubscriptionItemResponse|error - Get webhook subscription by uuid
deleteWebhookSubscription
Delete Webhook Subscription
Parameters
- id string - Webhook subscription uuid
Return Type
- error? - Webhook subscription removed
updateWebhookSubscription
function updateWebhookSubscription(string id, WebhookSubscriptionPatchRequest payload, map<string|string[]> headers) returns WebhookSubscriptionItemResponse|errorUpdate Webhook Subscription
Parameters
- id string - Webhook subscription uuid
- payload WebhookSubscriptionPatchRequest - Webhook subscription fields to update
Return Type
- WebhookSubscriptionItemResponse|error - Webhook subscription updated
updateWebhookSubscriptionSharedKey
function updateWebhookSubscriptionSharedKey(string id, map<string|string[]> headers) returns WebhookSubscriptionSharedKeyResponse|errorUpdate Webhook Subscription Shared Key
Parameters
- id string - Webhook subscription uuid
Return Type
- WebhookSubscriptionSharedKeyResponse|error - Webhook subscription shared key regenerated
listWebhookEvents
function listWebhookEvents(map<string|string[]> headers, *ListWebhookEventsQueries queries) returns WebhookEventPageResponse|errorList Webhook Events
Parameters
- queries *ListWebhookEventsQueries - Queries to be sent with the request
Return Type
- WebhookEventPageResponse|error - Page of webhook events
getWebhookEventDetails
function getWebhookEventDetails(string id, map<string|string[]> headers) returns WebhookEventDetailsResponse|errorWebhook Event Details
Parameters
- id string - Webhook event uuid
Return Type
- WebhookEventDetailsResponse|error - Get webhook event by uuid
listNotaries
function listNotaries(map<string|string[]> headers, *ListNotariesQueries queries) returns ListNotariesResponse|errorList Notaries
Parameters
- queries *ListNotariesQueries - Queries to be sent with the request
Return Type
- ListNotariesResponse|error - List of notaries retrieved successfully
listNotarizationRequests
function listNotarizationRequests(map<string|string[]> headers, *ListNotarizationRequestsQueries queries) returns ListNotarizationRequestsResponse|errorList Notarization Requests
Parameters
- queries *ListNotarizationRequestsQueries - Queries to be sent with the request
Return Type
- ListNotarizationRequestsResponse|error - Paginated list of notarization requests
createNotarizationRequest
function createNotarizationRequest(CreateNotarizationRequest payload, map<string|string[]> headers) returns CreateNotarizationResponse|errorCreate Notarization Request
Parameters
- payload CreateNotarizationRequest - Document, invitees, and notary details of the notarization request
Return Type
- CreateNotarizationResponse|error - Notarization request has been created successfully
getNotarizationRequestDetails
function getNotarizationRequestDetails(string sessionRequestId, map<string|string[]> headers) returns NotarizationRequestDetailsResponse|errorNotarization Request Details
Parameters
- sessionRequestId string - Notarization Request ID
Return Type
- NotarizationRequestDetailsResponse|error - Details about notarization request
deleteNotarizationRequest
function deleteNotarizationRequest(string sessionRequestId, map<string|string[]> headers) returns error?Delete Notarization Request
Parameters
- sessionRequestId string - Notarization Request ID
Return Type
- error? - No content
searchCatalogItems
function searchCatalogItems(map<string|string[]> headers, *SearchCatalogItemsQueries queries) returns ListCatalogItemsSearchResponse|errorList Catalog Items Search
Parameters
- queries *SearchCatalogItemsQueries - Queries to be sent with the request
Return Type
- ListCatalogItemsSearchResponse|error - Paginated catalog items
createCatalogItem
function createCatalogItem(ProductCatalogItemRequest payload, map<string|string[]> headers) returns ProductCatalogItemResponse|errorCreate Catalog Item
Parameters
- payload ProductCatalogItemRequest - Catalog item details to create
Return Type
- ProductCatalogItemResponse|error - Successfully created a new catalog item
getCatalogItem
function getCatalogItem(string itemUuid, map<string|string[]> headers) returns ProductCatalogItemResponse|errorCatalog Item Details
Parameters
- itemUuid string - Catalog item UUID
Return Type
- ProductCatalogItemResponse|error - Get Catalog Item
deleteCatalogItem
Delete Catalog Item
Parameters
- itemUuid string - Catalog item UUID
Return Type
- error? - No content
updateCatalogItem
function updateCatalogItem(string itemUuid, ProductCatalogItemPatchRequest payload, map<string|string[]> headers) returns ProductCatalogItemResponse|errorUpdate Catalog Item
Parameters
- itemUuid string - Catalog item UUID
- payload ProductCatalogItemPatchRequest - Catalog item fields to update
Return Type
- ProductCatalogItemResponse|error - Update Catalog item
getWorkspacePrivacySettings
function getWorkspacePrivacySettings(string workspaceId, map<string|string[]> headers) returns PrivacySettings|error[Beta] Workspace Privacy Settings Details
Parameters
- workspaceId string - Workspace id
Return Type
- PrivacySettings|error - Privacy settings for the workspace
updateWorkspacePrivacySettings
function updateWorkspacePrivacySettings(string workspaceId, UpdatePrivacySettings payload, map<string|string[]> headers) returns PrivacySettings|error[Beta] Update Workspace Privacy Settings
Parameters
- workspaceId string - Workspace id
- payload UpdatePrivacySettings - AI privacy settings to change. Omit fields you want to leave unchanged
Return Type
- PrivacySettings|error - Updated privacy settings for the workspace
updateQuote
function updateQuote(string documentId, string quoteId, QuoteUpdateRequest payload, map<string|string[]> headers) returns QuoteResponse|errorQuote update
Parameters
- documentId string - Document ID
- quoteId string - Quote ID
- payload QuoteUpdateRequest - Quote data to update on the document
Return Type
- QuoteResponse|error - OK
updateQuotesBatch
function updateQuotesBatch(string documentId, QuotesBatchUpdateRequest payload, map<string|string[]> headers) returns QuotesBatchUpdateResponse|error[Beta] Update Multiple Quotes
Parameters
- documentId string - Document ID
- payload QuotesBatchUpdateRequest - List of quote updates to apply in a single batch
Return Type
- QuotesBatchUpdateResponse|error - The batch was processed. See
results[].statusfor each quote's outcome
listWorkspaces
function listWorkspaces(map<string|string[]> headers, *ListWorkspacesQueries queries) returns ListWorkspacesResponse|errorList Workspaces
Parameters
- queries *ListWorkspacesQueries - Queries to be sent with the request
Return Type
- ListWorkspacesResponse|error - Page of workspaces
createWorkspace
function createWorkspace(CreateWorkspaceRequest payload, map<string|string[]> headers) returns CreateWorkspaceResponse|errorCreate Workspace
Parameters
- payload CreateWorkspaceRequest - Name and settings of the workspace to create
Return Type
deactivateWorkspace
function deactivateWorkspace(string workspaceId, record {} payload, map<string|string[]> headers) returns record {}|errorDeactivate Workspace
Parameters
- workspaceId string - ID of the workspace to deactivate
- payload record {} - Options for deactivating the workspace
Return Type
- record {}|error - Workspace was deactivated successfully
listUsers
function listUsers(map<string|string[]> headers, *ListUsersQueries queries) returns ListUsersResponse|errorList Users
Parameters
- queries *ListUsersQueries - Queries to be sent with the request
Return Type
- ListUsersResponse|error - Page of users
createUser
function createUser(CreateUserRequest payload, map<string|string[]> headers, *CreateUserQueries queries) returns CreateUserResponse|errorCreate User
Parameters
- payload CreateUserRequest - User and workspace details used to create the user
- queries *CreateUserQueries - Queries to be sent with the request
Return Type
- CreateUserResponse|error - OK
getUserDetails
Get User Details by ID
Parameters
- userId string - A unique identifier of the user
Return Type
- GetUserResponse|error - User details
addMember
function addMember(string workspaceId, AddMemberRequest payload, map<string|string[]> headers, *AddMemberQueries queries) returns AddMemberResponse|errorAdd Member to Workspace
Parameters
- workspaceId string - ID of the workspace to add the member to
- payload AddMemberRequest - User and role to add to the workspace
- queries *AddMemberQueries - Queries to be sent with the request
Return Type
- AddMemberResponse|error - OK
removeMember
function removeMember(string workspaceId, string memberId, map<string|string[]> headers) returns error?Remove Member from Workspace
Return Type
- error? - No Content
changeMemberRole
function changeMemberRole(string workspaceId, string memberId, UpdateMemberRoleRequest payload, map<string|string[]> headers) returns UpdateMemberRoleResponse|errorChange Member Role in Workspace
Parameters
- workspaceId string - Workspace id
- memberId string - Member id
- payload UpdateMemberRoleRequest - New role to assign to the workspace member
Return Type
createApiKey
function createApiKey(string workspaceId, CreateApiKeyRequest payload, map<string|string[]> headers) returns CreateApiKeyResponse|errorCreate API Key
Parameters
- workspaceId string - Workspace id
- payload CreateApiKeyRequest - Name and options of the API key to create
Return Type
listRecentSmsOptOuts
function listRecentSmsOptOuts(map<string|string[]> headers, *ListRecentSmsOptOutsQueries queries) returns ListSmsOptOutChangelogResponse|errorRecent SMS Opt-out
Parameters
- queries *ListRecentSmsOptOutsQueries - Queries to be sent with the request
Return Type
- ListSmsOptOutChangelogResponse|error - A list of phone numbers, their SMS current opt-out statuses and timestamp of the last change
createExportDocxTask
function createExportDocxTask(string documentId, map<string|string[]> headers) returns DocumentDocxExport|error[Beta] Create DOCX Export Task
Parameters
- documentId string - Specify document id
Return Type
- DocumentDocxExport|error - Export DOCX task was created
getDocxExportTask
function getDocxExportTask(string documentId, string taskId, map<string|string[]> headers) returns DocxExportTaskResponse|error[Beta] DOCX Export Task
Return Type
- DocxExportTaskResponse|error - Got state of export DOCX task
updateWorkspace
function updateWorkspace(string workspaceId, UpdateWorkspaceRequest payload, map<string|string[]> headers) returns UpdateWorkspaceResponse|error[Beta] Update Workspace
Parameters
- workspaceId string - Workspace id
- payload UpdateWorkspaceRequest - Workspace fields to update
Return Type
Records
pandadoc: AddMemberQueries
Represents the Queries record for the operation: addMember
Fields
- notifyUser? boolean - Send a confirmation email to the user that was added to workspace(s)
- notifyWsAdmins? boolean - Send a confirmation email to all workspace admins indicating that the user has been added to the workspace
pandadoc: AddMemberRequest
Fields
- role WorkspaceMemberRoleEnum - Role for a member
- userId string - User id
pandadoc: AddMemberResponse
Fields
- memberId? string -
- workspaceId? string -
- role? WorkspaceMemberRoleEnum - Role for a member
- lastName? string -
- firstName? string -
- email? string -
pandadoc: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - The
Authorizationheader must contain the API key. The value should be prefixed withAPI-Keyfollowed by a space and the actual API key.
pandadoc: APILogDetailsResponse
Fields
- userEmail? string -
- method? string -
- queryParamsObject? record {}? -
- queryParamsString? string? -
- responseBody? record {} -
- tokenType? string -
- url? string -
- requestTime? string -
- requestBody? record {} -
- application? string? -
- userId? string -
- responseTime? string -
- id? string -
- requestId? string -
- 'key? string -
- status? int -
pandadoc: APILogListResponse
Fields
- results? APILogListResponseResults[] -
pandadoc: APILogListResponseResults
Fields
- requestTime? string -
- responseTime? string -
- id? string -
- url? string -
- status? int -
pandadoc: AppendCLIDataRequest
Fields
- cli? AppendCLIDataRequestCli - Settings to append a CLI to a document, with ability to change some parameters
pandadoc: AppendCLIDataRequestCli
Settings to append a CLI to a document, with ability to change some parameters
Fields
- pages? AppendCLIDataRequestCliPages[] - The list of the CLI's pages you want to change in a result document
- id string - CLI ID to append to the first section
pandadoc: AppendCLIDataRequestCliPages
Fields
- name? string? - The name you want to apply to the CLI's page in a result document during appending the CLI
- index? int - The index of the CLI's page you want to change in a result document during appending the CLI
pandadoc: AppendCLIDataResponse
Fields
- cli? AppendCLIDataResponseCli - Settings of the appended to a document CLI. Name property can be different from what you passed if there were collisions
- blockMapping? AppendCLIDataResponseBlockMapping -
pandadoc: AppendCLIDataResponseBlockMapping
Maps the original names of content blocks from the CLI to their new names in the document. Use the 'new_name' to target blocks in subsequent API calls
Fields
- tables? AppendCLIDataResponseBlockMappingTables[] - Mapping for Table blocks
- images? AppendCLIDataResponseBlockMappingImages[] - Mapping for Image blocks
- texts? AppendCLIDataResponseBlockMappingTexts[] - Mapping for Text blocks
- pricingTables? AppendCLIDataResponseBlockMappingPricingTables[] - Mapping for Pricing Table blocks
pandadoc: AppendCLIDataResponseBlockMappingImages
Fields
- originalName? string - The name of the block in the source Content Library Item
- newName? string - The new, unique name of the block in the document after appending
pandadoc: AppendCLIDataResponseBlockMappingPricingTables
Fields
- originalName? string - The name of the block in the source Content Library Item
- newName? string - The new, unique name of the block in the document after appending
pandadoc: AppendCLIDataResponseBlockMappingTables
Fields
- originalName? string - The name of the block in the source Content Library Item
- newName? string - The new, unique name of the block in the document after appending
pandadoc: AppendCLIDataResponseBlockMappingTexts
Fields
- originalName? string - The name of the block in the source Content Library Item
- newName? string - The new, unique name of the block in the document after appending
pandadoc: AppendCLIDataResponseCli
Settings of the appended to a document CLI. Name property can be different from what you passed if there were collisions
Fields
- pages? AppendCLIDataResponseCliPages[] - The list of the CLI's pages you have changed in a result document
- id string - CLI ID appended to the first section
pandadoc: AppendCLIDataResponseCliPages
Fields
- name? string? - The real name in the page. It can be different from the one you passed if there were collisions (e.g. you appended the same CLI twice with the same names)
- index? int - The index of the CLI's page you have changed in a result document during appending the CLI
pandadoc: AssignedToRecipientDeliveryMethods
Fields
- sms? boolean -
- email? boolean -
pandadoc: AutoReminders
Fields
- initialDelayDays? int - Number of days to wait after sending the document before the first reminder is sent
- recurrenceFrequencyDays? int - Number of days between recurring reminders, applicable if
is_recurringistrue
- deliveryMethod? DocumentDeliveryMethodEnum -
- enabled boolean - Toggles auto-reminders for the document.
If
true, reminders are scheduled based on the configuration
- isRecurring? boolean - If
true, reminders will be sent repeatedly at specified intervals after the initial reminder
pandadoc: BaseActor
Fields
- role? string? - A recipient's role in the document from the template. A recipient will be added in CC if a role parameter is not provided
- signingOrder? int? - Set a signing order for a recipient. Learn more: https://developers.pandadoc.com/docs/set-signing-order
pandadoc: BaseEditingSessionResponse
Fields
- expiresAt? string - Date and time when the editing session expires
- id? string - Internal id of the editing session. Don't use it, it's not a token
- email? string - Email associated with the editing session
- 'key? string - Same value as
token, token for the embedded editor, aka E-Token. Deprecated — usetokeninstead
- token? string - Token for the embedded editor, aka E-Token. Use it for your Embedding
pandadoc: BaseField
Fields
- fieldId? string -
- isFilled? boolean - Whether the field has a completed value according to its type
- name? string - Name of a field
- placeholder? string - Placeholder of a field
- title? string -
- 'type? FieldTypeEnum -
- uuid? string -
- assignedTo? RecipientAssignedTo|RecipientsGroupAssignedTo -
pandadoc: BaseIdentity
Fields
- phone? string? - A recipient's phone number
- lastName? string? - A recipient's last name. We automatically take the last name from contact data if this field is missed
- firstName? string? - A recipient's first name. We automatically take the first name from contact data if this field is missed
- email? string? - A recipient's email address
pandadoc: BulkDeleteDocumentsRequestItem
Fields
- id string - Document ID to delete
pandadoc: BulkDeleteDocumentsResponse
Fields
- id string[] - Document IDs that were deleted, in the same order as processed by the API
pandadoc: ChangeDocumentStatusWithUploadRequest
Fields
- file? record { fileContent byte[], fileName string } - Binary attachment file
- data? DocumentStatusChangeRequest -
pandadoc: Checkbox
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "checkbox" -
- value? boolean - Value of the Checkbox field
- mergeField? string -
pandadoc: CollectFile
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "collect_file" -
- value? CollectFile_value - Value of the Collect File field
pandadoc: CollectFile_value
Value of the Collect File field
Fields
- name? string - Name of the collected file
- url? string - URL of the collected file
pandadoc: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig|ApiKeysConfig - Provides Auth configurations needed when communicating with a remote HTTP endpoint.
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
pandadoc: ContactCreateRequest
Fields
- country? string? - A country name
- streetAddress? string? - A street address
- phone? string? - A phone number
- city? string? - A city name
- lastName? string? - Contact's last name
- company? string? - Contact's company name
- state? string? - A state name
- postalCode? string? - A postal code
- firstName? string? - Contact's first name
- jobTitle? string? - Contact's job title
- email? string? - An email address of the contact
pandadoc: ContactDetailsResponse
Fields
- country? string? - A country name
- streetAddress? string? - A street address
- phone? string? - A phone number
- city? string? - A city name
- lastName? string? - Contact's last name
- company? string? - Contact's company name
- id? string - A unique identifier of the contact
- state? string? - A state name
- postalCode? string? - A postal code
- firstName? string? - Contact's first name
- jobTitle? string? - Contact's job title
- email? string? - An email address of the contact
pandadoc: ContactListResponse
Fields
- results? ContactDetailsResponse[] -
pandadoc: ContactUpdateRequest
Fields
- streetAddress? string? -
- phone? string? -
- city? string? -
- lastName? string? -
- company? string? -
- state? string? -
- postalCode? string? -
- firstName? string? -
- jobTitle? string? -
pandadoc: ContentLibraryItemCreateFromUrlRequest
Fields
- url? string - Secure (HTTPS) and publicly accessible URL to the PDF document
- Fields Included from *ContentLibraryItemCreateRequest
pandadoc: ContentLibraryItemCreateRequest
Fields
- editable boolean(default false) - Only applicable when creating a content library item from a DOCX file. When
true, the DOCX is converted into editable content, so the resulting content library item can be edited
- name? string - The name of the Content Library Item
pandadoc: ContentLibraryItemListResponse
Fields
- results? ContentLibraryItemListResponseResults[] -
pandadoc: ContentLibraryItemListResponseResults
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- id? string -
- version? string -
pandadoc: ContentLibraryItemResponse
Fields
- metadata? record {} -
- images? record {}[] -
- dateCreated? string -
- roles? record {}[] -
- contentDateModified? string -
- createdBy? ContentLibraryItemResponseCreatedBy -
- version? string -
- tags? string[] -
- tables? DocumentDetailsResponseTables[] - Document tables
- dateModified? string -
- folderUuid? string? -
- name? string -
- 'lock? record {}? -
- tokens? record {}[] -
- id? string -
- fields? record {}[] -
- pricing? PricingResponse -
- contentPlaceholders? record {}[] -
pandadoc: ContentLibraryItemResponseCreatedBy
Fields
- membershipId? string? -
- lastName? string -
- id? string -
- avatar? string? -
- firstName? string -
- email? string -
pandadoc: ContentLibraryResponse
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- id? string -
- version? string -
- status? "cli.UPLOADED"|"cli.PROCESSED"|"cli.ERROR" -
pandadoc: CreateApiKeyRequest
Fields
- userId? string -
- 'type ApiKeyTypeEnum - A type of API key
pandadoc: CreateApiKeyResponse
Fields
- workspaceId? string - A unique identifier of the workspace
- userId? string - A unique identifier of the user
- 'type? ApiKeyTypeEnum - A type of API key
- 'key? string - A New Public API key
pandadoc: CreateContentLibraryItemFromUploadRequest
Fields
- file? record { fileContent byte[], fileName string } - Binary PDF File
- data? ContentLibraryItemCreateRequest -
pandadoc: CreateDocumentFieldsRequest
Fields
- fields? DocumentFieldsFieldCreate[] - An array of fields to place on a document
pandadoc: CreateDocumentFieldsResponse
Fields
- fields? DocumentFieldsField[] -
pandadoc: CreateDocumentFromUploadQueries
Represents the Queries record for the operation: createDocumentFromUpload
Fields
- editorVer? string - Set this parameter as
ev1if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace
- useFormFieldProperties? string - Set this parameter as
yesor1ortrue(only when upload pdf with form fields) if you want to respect form fields properties, likerequired
pandadoc: CreateDocumentFromUploadRequest
Fields
- file? record { fileContent byte[], fileName string } - Binary PDF File
- data? DocumentCreateByPdfRequest -
pandadoc: CreateDocumentQueries
Represents the Queries record for the operation: createDocument
Fields
- editorVer? string - Set this parameter as
ev1if you want to create a document from PDF with Classic Editor when both editors are enabled for the workspace
- useFormFieldProperties? string - Set this parameter as
yesor1ortrue(only when upload pdf with form fields) if you want to respect form fields properties, likerequired
pandadoc: CreateDocumentRecipient
Fields
- Fields Included from *BaseActor
- Fields Included from *BaseIdentity
- deliveryMethods? RecipientDeliveryMethods? -
- redirect? RecipientRedirect -
- verificationSettings? RecipientVerificationSettings -
- 'type? "recipient" -
pandadoc: CreateDocumentRecipientGroup
Fields
- Fields Included from *BaseActor
- members? BaseIdentity[] -
- name string -
- 'type "recipient_group" -
pandadoc: CreateMemberTokenRequest
Fields
- lifetime int(default 3600) - Token lifetime in seconds
pandadoc: CreateMemberTokenResponse
Fields
- token? string -
pandadoc: CreateNotarizationRequest
Fields
- notary? CreateNotarizationRequestNotary - Optional notary assignment for in-house notary requests. Used for Bring you own notary use case. Only ACTIVE notaries can be used
- invitation CreateNotarizationRequestInvitation -
- documentId string - ID of the Document for notarization
- disableInviteesNotifications boolean?(default false) - Disable all notifications for invitees including email with invitation for notarization. This is useful when you are using alternative delivery methods
pandadoc: CreateNotarizationRequestInvitation
Fields
- invitees? CreateNotarizationRequestInvitationInvitees[] -
- message? string - Optional message for invitation email
pandadoc: CreateNotarizationRequestInvitationInvitees
Fields
- lastName? string? -
- firstName? string? -
- email string -
pandadoc: CreateNotarizationRequestNotary
Optional notary assignment for in-house notary requests. Used for Bring you own notary use case. Only ACTIVE notaries can be used
Fields
- scheduledAt string - ISO 8601 timestamp for scheduled notarization
- id string - ID of an ACTIVE notary
- message? string - Optional custom message for the notary in the invitation email
pandadoc: CreateNotarizationResponse
Fields
- dateAccepted? string? - A date when a notarization session was accepted by notary
- invitees? CreateNotarizationResponseInvitees[] -
- dateCreated? string - A date when a notarization request was created
- name? string - A name of the notarization request
- id? string - A unique identifier of the notarization request
- createdBy? CreateNotarizationResponseCreatedBy -
- status? "DRAFT"|"SENT"|"WAITING_FOR_NOTARY"|"ACCEPTED"|"LIVE"|"COMPLETED"|"INCOMPLETE"|"CANCELLED" - Current status of the notarization request
pandadoc: CreateNotarizationResponseCreatedBy
Fields
- userId? string - A unique identifier of the user who created a notarization request
- lastName? string - A user's last name
- firstName? string - A user's first name
- email? string - A user's email address
pandadoc: CreateNotarizationResponseInvitees
Fields
- notarizationLink? string - A secure link to join a notarization request
- lastName? string - A invitee's last name
- id? string - A unique identifier of the invitee
- firstName? string - A invitee's first name
- email? string - A invitee's email address
pandadoc: CreateTemplateFromUrlRequest
Fields
- url? string - Secure (HTTPS) and publicly accessible URL to the PDF document
- Fields Included from *CreateTemplateRequest
- owner CreateTemplateRequestOwner
- metadata record { anydata... }|()
- editable boolean
- folderUuid string
- name string
- tokens Tokens
- anydata...
pandadoc: CreateTemplateQueries
Represents the Queries record for the operation: createTemplate
Fields
- fields? ("content_date_modified")[] - A comma-separated list of additional fields to include in the response
pandadoc: CreateTemplateRequest
Fields
- owner? CreateTemplateRequestOwner - You can set an owner of a template as an
emailormembership_id
- metadata? record {}? - You can pass arbitrary data in the key-value format to associate custom information with a template. This information is returned in any API requests for the template details by id
- editable boolean(default false) - Only applicable when creating a template from a DOCX file. When
true, the DOCX is converted into editable content, so the resulting template can be edited
- folderUuid? string - The ID of the folder where the created template should be stored
- name? string - The name of the template
- tokens? Tokens - Create or initialize multiple CUSTOM variables with their values using tokens/values list. Template's predefined variables are read-only. Any attempts to do so will be ignored
pandadoc: CreateTemplateRequestOwner
You can set an owner of a template as an email or membership_id
Fields
- membershipId? string - Workspace membership ID of the owner
- email? string - Email address of the owner
pandadoc: CreateTemplateWithUploadQueries
Represents the Queries record for the operation: createTemplateWithUpload
Fields
- fields? ("content_date_modified")[] - A comma-separated list of additional fields to include in the response
pandadoc: CreateTemplateWithUploadRequest
Fields
- file? record { fileContent byte[], fileName string } - Binary PDF/DocX/RTF File
- data? CreateTemplateRequest -
pandadoc: CreateUserQueries
Represents the Queries record for the operation: createUser
Fields
- notifyUser? boolean - Send a confirmation email to the user that was added to workspace(s)
- notifyWsAdmins? boolean - Send a confirmation email to all workspace admins indicating that the user has been added to the workspace
pandadoc: CreateUserRequest
Fields
- license UserLicenseEnum -
- workspaces CreateUserRequestWorkspaces[] - Info for adding a user to a workspace(s)
- user CreateUserRequestUser - User info
pandadoc: CreateUserRequestUser
User info
Fields
- lastName? string - Last name of the user
- phoneNumber? string - Phone number of the user
- firstName? string - First name of the user
- email? string - Email address of the user
pandadoc: CreateUserRequestWorkspaces
Fields
- workspaceId? string -
- role? WorkspaceMemberRoleEnum - Role for a member
pandadoc: CreateUserResponse
Fields
- userId? string -
- workspaces? CreateUserResponseWorkspaces[] -
pandadoc: CreateUserResponseWorkspaces
Fields
- workspaceId? string -
- memberId? string -
- role? string -
pandadoc: CreateWorkspaceRequest
Fields
- iconUrl? string - Workspace icon will be displayed in the application and is not visible to your customers. Icon should have square proportions. Supported formats: JPEG, PNG, GIF, WEBP. Max size: 5 MB
- settings? CreateWorkspaceRequestSettings - Optional workspace settings applied at creation time
- name string - A name for the new workspace
pandadoc: CreateWorkspaceRequestSettings
Optional workspace settings applied at creation time
Fields
- allowJoinByDomain boolean(default true) - Allow anyone at your domain to join this workspace upon request
- allowRequestAccess boolean(default true) - Allow anyone to request access to documents
pandadoc: CreateWorkspaceResponse
Fields
- name? string -
- id? string -
pandadoc: Date
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "date" -
- value? string - Value of the Date field
- mergeField? string -
pandadoc: DocumentAttachmentCreateFromFile
Fields
- file? record { fileContent byte[], fileName string } - Binary file to be attached to a document
- Fields Included from *DocumentAttachmentMetadata
- name string
- anydata...
pandadoc: DocumentAttachmentMetadata
Fields
- name? string - Optional name to set for uploaded file
pandadoc: DocumentAttachmentRequest
Fields
- 'source? string - URL link to the file to be attached to a document
- Fields Included from *DocumentAttachmentMetadata
- name string
- anydata...
pandadoc: DocumentAttachmentResponse
Fields
- dateCreated? string -
- name? string? -
- uuid? string -
- createdBy? DocumentAttachmentResponseCreatedBy -
pandadoc: DocumentAttachmentResponseCreatedBy
Fields
- lastName? string -
- id? string -
- avatar? string? -
- firstName? string -
- email? string -
pandadoc: DocumentAuditTrailResponse
Fields
- count? int - Total number of audit trail entries available
- results? DocumentAuditTrailResponseResults[] - List of audit trail entries returned for the current page
pandadoc: DocumentAuditTrailResponseResults
Represents a single audit trail event for a document
Fields
- reason? string? - Optional reason or explanation for the action
- dateCreated? string - Timestamp when the action was performed (in ISO 8601 format)
- action? int - Numeric code representing the type of action performed. Possible values: | Integer Value | String Representation | |---------------|---------------------------------------------| | 1 | new document | | 2 | new revision | | 3 | approval request | | 4 | approved | | 5 | rejected | | 6 | sent | | 7 | completed by all | | 8 | viewed | | 9 | completed | | 10 | waiting pay | | 11 | paid | | 12 | forwarded | | 13 | expired | | 14 | bank account submitted | | 15 | bank account verified | | 16 | payment submitted | | 17 | payment failed | | 18 | completed manually | | 19 | expired manually | | 20 | paid manually | | 21 | approval deleted | | 22 | approval forced | | 23 | reassigned | | 24 | recipient edited | | 25 | recipient added | | 26 | recipient deleted | | 27 | declined manually | | 28 | approval step skipped | | 29 | suggest edits | | 43 | declined | | 44 | partly paid | | 45 | partly paid manually | | 47 | recipient verification with kba passed | | 48 | recipient verification with id passed | | 49 | recipient verification with text sms passed | | 50 | recipient verification with passcode passed | | 51 | recipient verification with kba failed | | 52 | recipient verification with id failed | | 53 | recipient verification with text sms failed | | 54 | recipient verification with passcode failed | | 55 | recipient signed with QES | | 56 | QES completed | | 57 | recipient QES attempt started | | 58 | recipient QES attempt expired | | 59 | Optional item in quote selected | | 60 | Optional item in quote deselected | | 61 | Item quantity in quote changed | | 62 | Item quantity in pricing table changed | | 63 | Optional item in pricing table selected | | 64 | Optional item in pricing table deselected | | 65 | Section item in pricing table selected (one of) | | 66 | Optional section in quote selected | | 67 | Optional section in quote deselected | | 68 | Section quantity in quote changed | | 69 | recipient verification with email otp passed | | 70 | recipient verification with email otp failed |
- id? string - Unique identifier of the audit trail entry
- ipAddress? string? - The IP address from which the action was performed. If a sandbox API key is used, this will be "hidden"
- user? DocumentAuditTrailResponseUser - The user who triggered the action
pandadoc: DocumentAuditTrailResponseUser
The user who triggered the action
Fields
- id? string - Unique identifier of the user
- email? string - User's email address
pandadoc: DocumentAutoRemindersResponse
Fields
- reminders? DocumentAutoRemindersResponseReminders[] -
pandadoc: DocumentAutoRemindersResponseReminders
Fields
- recipientId string - Unique identifier of the recipient
- status? "sent"|"error"|"scheduled" - Status of the reminder attempt (sent, error, scheduled)
pandadoc: DocumentCreateByPdfRequest
Fields
- owner? DocumentCreateByTemplateRequestOwner - The owner of the document. Pass either
emailormembership_idof the user in the workspace
- metadata? record {}? - You can pass any data in a key-value format to associate it with a document. Searching by metadata is available in the List Documents endpoint and is also included in the Document Details response
- editable boolean(default false) - Only applicable when creating a document from a DOCX file. When
true, the DOCX is converted into editable content, so the resulting document can be edited. Cannot be combined withparse_form_fieldsorfields, which place fields by coordinates on PDF pages
- recipients? CreateDocumentActor[] - The list of recipients to whom the document will be sent. Either
emailorphoneis required. Specifying theroleassigns all matching fields to the recipient or group. Iffirst_nameandlast_nameare not specified, the system looks them up in the workspace contacts list using theemailorphone number. Iffirst_nameandlast_nameare provided, they override the existing contact's data
- folderUuid? string - ID of the folder where the created document should be stored
- name string - Name the document you are creating
- parseFormFields? boolean - Set this parameter as
trueif you create a document from a PDF with form fields and asfalseif you upload a PDF with field tags
- tokens? DocumentCreateByTemplateRequestTokens[] - Also known as variables. Pass values for the variables in the template to render them into the created document or make them available for insertion later
- fields? record { DocumentCreateByTemplateRequestFields... } - Set specific values to the fields. This object maps merge field names to their corresponding values.
Each key represents a merge field name, and each value is an object containing the data to populate that field with. The structure allows you to pre-populate various field types including text inputs, checkboxes, dropdowns, and date fields.
Key Points:
- Keys must match the exact merge field names from your template or file.
- Values must be wrapped in an object with a
valueproperty. - Supported value types: string, number, boolean.
- Date fields should use RFC 3339 format (e.g., '2019-12-31T00:00:00.000Z').
- Signature fields cannot be pre-filled.
- Text field:
"CustomerName": {"value": "John Doe"} - Checkbox:
"AgreeToTerms": {"value": true} - Date field:
"DeliveryDate": {"value": "2019-12-31T00:00:00.000Z"}
- tags? string[] - Mark your document with one or more tags. Tags are displayed in the UI, and you can filter by tags in the List Documents endpoint
pandadoc: DocumentCreateByPdfUrlRequest
Fields
- url string - Secure (HTTPS) and publicly accessible URL to the PDF document
- Fields Included from *DocumentCreateByPdfRequest
- owner DocumentCreateByTemplateRequestOwner
- metadata record { anydata... }|()
- editable boolean
- recipients CreateDocumentActor[]
- folderUuid string
- name string
- parseFormFields boolean
- tokens DocumentCreateByTemplateRequestTokens[]
- fields record { DocumentCreateByTemplateRequestFields... }
- tags string[]
- anydata...
pandadoc: DocumentCreateByTemplateRequest
Fields
- owner? DocumentCreateByTemplateRequestOwner - The owner of the document. Pass either
emailormembership_idof the user in the workspace
- images? DocumentCreateByTemplateRequestImages[] - You can pass a list of images to image blocks (one image in one block) for replacement
- metadata? record {}? - You can pass any data in a key-value format to associate it with a document. Searching by metadata is available in the List Documents endpoint and is also included in the Document Details response
- templateUuid string - The ID of a template you want to use. You can copy it from an in app template url such as
https://app.pandadoc.com/a/#/templates/{ID}/content. A template ID is also obtained by listing templates
- pricingTables? PricingTableRequest[] - Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. Make sure that "Automatically add products to this table" is enabled in the PandaDoc template pricing tables you wish to populate via API
- tags? string[] - Mark your document with one or more tags. Tags are displayed in the UI, and you can filter by tags in the List Documents endpoint
- tables? TableRequest[] - Information to construct or populate a table can be passed when creating a document. Keep in mind that this is an array, so multiple table objects can be passed to a document
- texts? DocumentCreateByTemplateRequestTexts[] - You can pass a list of rich text values to pre-fill text blocks in a template. This is useful for inserting dynamic content like introductions or terms and conditions. Markdown is supported
- recipients CreateDocumentActor[] - The list of recipients to whom the document will be sent. Either
emailorphoneis required. Specifying theroleassigns all matching fields to the recipient or group. Iffirst_nameandlast_nameare not specified, the system looks them up in the workspace contacts list using theemailorphone number. Iffirst_nameandlast_nameare provided, they override the existing contact's data
- folderUuid? string - ID of the folder where the created document should be stored
- name? string - Name the document you are creating
- detectTitleVariables? boolean - Set this parameter as true if you want to detect title variables in the document
- tokens? DocumentCreateByTemplateRequestTokens[] - Also known as variables. Pass values for the variables in the template to render them into the created document or make them available for insertion later
- fields? record { DocumentCreateByTemplateRequestFields... } - Set specific values to the fields. This object maps merge field names to their corresponding values.
Each key represents a merge field name, and each value is an object containing the data to populate that field with. The structure allows you to pre-populate various field types including text inputs, checkboxes, dropdowns, and date fields.
Key Points:
- Keys must match the exact merge field names from your template or file.
- Values must be wrapped in an object with a
valueproperty. - Supported value types: string, number, boolean.
- Date fields should use RFC 3339 format (e.g., '2019-12-31T00:00:00.000Z').
- Signature fields cannot be pre-filled.
- Text field:
"CustomerName": {"value": "John Doe"} - Checkbox:
"AgreeToTerms": {"value": true} - Date field:
"DeliveryDate": {"value": "2019-12-31T00:00:00.000Z"}
- contentPlaceholders? DocumentCreateByTemplateRequestContentPlaceholders[] - You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there
pandadoc: DocumentCreateByTemplateRequestContentLibraryItems
Fields
- recipients? DocumentCreateByTemplateRequestRecipients[] -
- pricingTables? PricingTableRequest[] -
- id string - Content library item id
- fields? record {} -
pandadoc: DocumentCreateByTemplateRequestContentPlaceholders
Fields
- contentLibraryItems? DocumentCreateByTemplateRequestContentLibraryItems[] -
- blockId string - Content placeholder block id
pandadoc: DocumentCreateByTemplateRequestFields
Fields
- role? string - Assign this field to a recipient role. The role must be present in the
recipientslist
pandadoc: DocumentCreateByTemplateRequestImages
Fields
- urls string[] -
- name string -
pandadoc: DocumentCreateByTemplateRequestOwner
The owner of the document. Pass either email or membership_id of the user in the workspace
Fields
- membershipId? string - Workspace membership ID of the owner
- email? string - Email address of the owner
pandadoc: DocumentCreateByTemplateRequestRecipients
Fields
- deliveryMethods? RecipientDeliveryMethods? -
- redirect? RecipientRedirect -
- role? string -
- phone? string? -
- lastName? string -
- signingOrder? int? -
- firstName? string -
- email? string? -
pandadoc: DocumentCreateByTemplateRequestTexts
Fields
- data string - The text content to be inserted into the block. Supports markdown
- name string - The name of the Text Block to update. This name is defined in the template
pandadoc: DocumentCreateByTemplateRequestTokens
Fields
- name string -
- value string -
pandadoc: DocumentCreateLinkRequest
Fields
- recipient string - Email address of the person who will receive access to the document
- lifetime decimal(default 3600) - The duration in seconds for which the document link will remain valid. The link will expire and become inaccessible after this time period.
For security, we recommend setting the lifetime to less than one year (e.g.,
"lifetime": 31535999). If not specified, the default value is 1 hour (3600 seconds)
pandadoc: DocumentCreateLinkResponse
Fields
- expiresAt? string - The date and time when the session will expire
- id? string - The session ID
pandadoc: DocumentCreateResponse
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- links? DocumentCreateResponseLinks[] -
- id? string -
- expirationDate? string? -
- version? string? -
- uuid? string -
- infoMessage? string -
- status? DocumentStatusEnum -
pandadoc: DocumentCreateResponseLinks
Fields
- rel? string -
- href? string -
- 'type? string -
pandadoc: DocumentDetailsRecipient
Fields
- Fields Included from *RecipientPersonalDetails
- deliveryMethods? RecipientDeliveryMethods? -
- redirect? RecipientRedirect -
- signatureDate? string? -
- phone? string? -
- verificationSettings? RecipientVerificationSettingsResponse? -
- lastName? string -
- sharedLink? string -
- avatar? string? -
- contactId? string -
- 'type? "recipient" -
- firstName? string -
- hasCompleted? boolean -
pandadoc: DocumentDetailsRecipientGroup
Fields
- Fields Included from *RecipientPersonalDetails
- members? DocumentDetailsRecipientGroupMember[] -
- name? string -
- 'type? "recipient_group" -
pandadoc: DocumentDetailsRecipientGroupMember
Recipient Group Member
Fields
- signatureDate? string? - Date and time the member signed the document
- lastName? string - Last name of the group member
- sharedLink? string - Link the group member uses to open the document
- id? string - Unique identifier of the group member
- avatar? string? - URL of the group member's avatar image
- firstName? string - First name of the group member
- email? string? - Email address of the group member
pandadoc: DocumentDetailsResponse
Fields
- template? DocumentDetailsResponseTemplate? - Source template of the document.
nullfor documents created from multiple templates (bundles) because only a single parent template is stored
- refNumber? string - Document reference number
- metadata? record {} - Document metadata
- expirationDate? string? - Document expiration date
- autonumberingSequenceNamePrefix? anydata -
- tables? DocumentDetailsResponseTables[] - Document tables
- sentBy? DocumentDetailsResponseSentBy? -
- dateCompleted? string? - Document completion date
- 'lock? record {}? -
- tokens? Token[] - Document tokens
- id? string - Document ID
- grandTotal? DocumentDetailsResponseGrandTotal -
- qesStatus? DocumentQESStatusEnum? - The status of the QES (Qualified Electronic Signature) for the document. Null if the QES is disabled for document
- images? DocumentDetailsResponseImages[] - Document images
- dateSent? string? - Document sent date
- dateCreated? string - Document creation date
- contentDateModified? string - Document content modification date
- createdBy? DocumentDetailsResponseCreatedBy -
- version? string - Document version
- approvalExecution? DocumentDetailsResponseApprovalExecution? -
- tags? string[] - Document tags
- dateModified? string - Document modification date
- texts? DocumentDetailsResponseTexts[] - Document text blocks
- recipients? DocumentDetailsResponseRecipients[] - Document recipients
- folderUuid? string? - ID of the folder where the created document should be stored
- name? string - Document name
- fields? Field[] - Document fields
- linkedObjects? DocumentDetailsResponseLinkedObjects[] - Document linked objects
- pricing? PricingResponse -
- status? DocumentStatusEnum -
pandadoc: DocumentDetailsResponseApprovalExecution
Document approval execution
Fields
- revisionNumber? int - Consequent number of revision for related RegularDocument
- documentUuid? string - Decoded uuid of related RegularDocument instance
pandadoc: DocumentDetailsResponseChildren
Fields
- entityType? string - Linked object child entity type
- id? string - Linked object child ID
- entityId? string - Linked object child entity ID
pandadoc: DocumentDetailsResponseCreatedBy
Document creator details
Fields
- membershipId? string - Creator membership ID
- lastName? string - Creator last name
- id? string - Creator ID
- avatar? string? - Creator avatar URL
- firstName? string - Creator first name
- email? string - Creator email
pandadoc: DocumentDetailsResponseGrandTotal
Document grand total
Fields
- amount? string - Total amount
- currency? string - Currency type
pandadoc: DocumentDetailsResponseImages
Fields
- name? string - Image name
pandadoc: DocumentDetailsResponseLinkedObjects
Fields
- entityType? string - Linked object entity type
- provider? string - Linked object provider
- children? DocumentDetailsResponseChildren[] - Linked object children array
- id? string - Linked object ID
- entityId? string - Linked object entity ID
pandadoc: DocumentDetailsResponseSentBy
Document sent by
Fields
- lastName? string - Last name of the sender
- id? string - Unique identifier of the sender
- avatar? string? - URL of the sender's avatar image
- firstName? string - First name of the sender
- email? string - Email address of the sender
pandadoc: DocumentDetailsResponseTables
Fields
- name? string - Table name
pandadoc: DocumentDetailsResponseTemplate
Source template of the document. null for documents created from multiple templates (bundles) because only a single parent template is stored
Fields
- name? string - Template name
- id? string - Template ID
pandadoc: DocumentDetailsResponseTexts
Fields
- name? string - Text name
pandadoc: DocumentDocxExport
Fields
- id string - Export task id
- documentId string - Document id
- status DocumentDocxExportStatusEnum - | Status | Description | |---------------|---------------------------------------------------------------------------------------------| | created | The export task has been created, but the process has not started. | | processing| The export task is in progress. | | done | The export task is completed, and the response contains URLs for downloading the documents. | | error | An error occurred during the execution of the export task. |
pandadoc: DocumentEditingSessionResponse
Fields
- Fields Included from *BaseEditingSessionResponse
- documentId? string - ID of the document
pandadoc: DocumentESignDisclosure
Fields
- result? DocumentESignDisclosureResult -
pandadoc: DocumentESignDisclosureResult
Fields
- isEnabled? boolean - Indicates whether the ESign disclosure feature is enabled for the document
- esignDisclosureText? string? - Rich text (HTML) of the pre-configured ESign disclosure
- companyName? string? -
pandadoc: DocumentFieldAssignmentItem
Specifies a field and the recipient it should be assigned or unassigned to
Fields
- fieldId string - UUID of the field to assign or unassign
- assignedTo string? - UUID of the recipient to assign the field to. Set to
nullto unassign the field from its current recipient
pandadoc: DocumentFieldOptionCreate
Fields
- text string - Option label
- position? DocumentFieldOptionCreatePosition - Option position relative to the field. Used by
radio_buttonsfields
pandadoc: DocumentFieldOptionCreatePosition
Option position relative to the field. Used by radio_buttons fields
Fields
- offsetX? decimal - Horizontal offset of the option from the field
- offsetY? decimal - Vertical offset of the option from the field
pandadoc: DocumentFieldSettingsCreate
Field configuration. The available properties depend on the field type
Fields
- masked? boolean - Hide the entered value behind a mask. Applies to text and date fields
- multiline? boolean - Allow the value to span multiple lines. Applies to text fields
- options? DocumentFieldOptionCreate[] - Selectable options. Applies to
radio_buttonsanddropdownfields. Forradio_buttons, include apositionfor each option to place it on the page
- placeholder? string - Placeholder text shown in the field. Applies to text, date, dropdown, payment, and collected file fields
- showValues boolean(default true) - Show the option values next to the radio buttons. Applies to
radio_buttonsfields. Set tofalseto hide the values
- required boolean(default true) - Whether the recipient must complete the field
pandadoc: DocumentFieldsField
Fields
- fieldId? string -
- layout? DocumentFieldsLayout -
- sectionUuid? string -
- isFilled? boolean -
- name? string -
- placeholder? string -
- title? string -
- 'type? FieldTypeEnum -
- uuid? string -
- value? anydata -
- assignedTo? DocumentFieldsFieldAssignedTo -
pandadoc: DocumentFieldsFieldAssignedTo
Fields
- recipientType? string -
- deliveryMethods? anydata -
- redirect? anydata -
- phone? string -
- lastName? string -
- signingOrder? anydata -
- id? string -
- 'type? string -
- firstName? string -
- email? string -
- hasCompleted? boolean -
pandadoc: DocumentFieldsFieldCreate
Fields
- fieldId? string - Optional unique identifier
- layout DocumentFieldsLayout -
- settings? DocumentFieldSettingsCreate - Field configuration. The available properties depend on the field
type
- 'type FieldTypeEnum -
- mergeField? string - Use this to dynamically populate this field with data from your CRM or API. Supported field types:
- text
- checkbox
- date
- dropdown
- radio_buttons
- assignedTo? string - Optional uuid of a recipient
pandadoc: DocumentFieldsLayout
Fields
- style DocumentFieldsLayoutStyle -
- page int -
- position DocumentFieldsLayoutPosition -
pandadoc: DocumentFieldsLayoutPosition
Fields
- offsetX decimal -
- offsetY decimal -
- anchorPoint DocumentFieldAnchorPointEnum -
pandadoc: DocumentFieldsLayoutStyle
Fields
- width int -
- height int -
pandadoc: DocumentListResponse
Fields
- results? DocumentListResponseResults[] -
pandadoc: DocumentListResponseResults
Fields
- dateSent? string? -
- dateModified? string -
- dateCreated? string -
- name? string -
- dateCompleted? string? -
- id? string -
- expirationDate? string? -
- version? string -
- status? string -
pandadoc: DocumentLockInfo
Describes the user and lifetime of an active document editing lock
Fields
- expiresAt? string - ISO 8601 timestamp when the lock automatically expires
- lockedByUserId? string - A unique identifier of the user holding the lock
- lockType? "wopi_editing" - Type of the active document lock
pandadoc: DocumentRecipientCreateRequest
Fields
- kind RecipientKindEnum -
- id string - Contact uuid
pandadoc: DocumentRecipientEditRequest
Fields
- deliveryMethods? RecipientDeliveryMethods? -
- redirect? RecipientRedirect -
- streetAddress? string? -
- country? string? -
- city? string? -
- lastName? string? -
- title? string? -
- phone? string? -
- verificationSettings? RecipientVerificationSettings -
- company? string? -
- state? string? -
- postalCode? string? -
- firstName? string? -
- email? string? - You cannot use the email of another contact when updating a recipient contact
pandadoc: DocumentRecipientGroupEditMember
A recipient group member. email is required and is the identity used to match members across edits. Phone is not supported for group members
Fields
- lastName? string? - The member's last name
- firstName? string? - The member's first name
- email string - The member's email address. Required: it identifies the member when diffing the group's membership
pandadoc: DocumentRecipientGroupEditRequest
Update a recipient group's name and/or its members. Provide at least one
of name or members.
When members is sent, it replaces the group's current membership:
members not present in the list are removed from the group, and any new
members are added. On a sent document, newly added members are notified
and removed members lose access. Members are matched by email; for a
retained member, only the contact fields you include (first_name,
last_name) are updated, and omitted fields keep their existing values
Fields
- members? DocumentRecipientGroupEditMember[] - The full list of members the group should contain after the update. Must contain at least one member when provided
- name? string - New name for the recipient group
pandadoc: DocumentRecipientResponse
Fields
- recipientId? string -
pandadoc: DocumentRevertToDraftResponse
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- id? string -
- expirationDate? string? -
- version? string -
- status? string -
pandadoc: DocumentSendManualReminder200Response
Fields
- result? DocumentSendManualReminder200ResponseResult[] -
pandadoc: DocumentSendManualReminder200ResponseEmail
Fields
- sentAt? string? - Timestamp of when the reminder was sent, in ISO 8601 format. Present only on success
- detail? "Can't send reminder to CC recipient"|"Can't send reminder to the Recipient who completed their part"|"Can't send reminder. Signing order is enabled and this Recipient can't sign the document yet"|"Can't send reminder. Email delivery method is not selected for recipient"|"Can't send email reminder. Recipient's mailbox is unreachable"|"Can't send email reminder to the Recipient with no email"|"Can't send email reminder to the Recipient more than once every 24 hours"|"Can't send reminder. The document does not contain a recipient with the specified recipient ID"|"Can’t send reminder. Email message contains potentially malicious links and could not be processed"? - Detailed explanation of why the reminder could not be sent. Present only on error
- status? "sent"|"error" - Status of the email reminder attempt (sent or error)
pandadoc: DocumentSendManualReminder200ResponseEmailCustomization
Optional customization settings for the reminder email. Defines the subject and body text used when sending the reminder via email
Fields
- subject? string? - Subject line of the reminder email sent to the recipient
- message? string? - Custom message body of the reminder email. Can include friendly or contextual text encouraging the recipient to complete the signing process. Supports Markdown syntax for rich text formatting (e.g., bold, italics, links, and line breaks)
pandadoc: DocumentSendManualReminder200ResponseResult
Fields
- emailCustomization? DocumentSendManualReminder200ResponseEmailCustomization -
- recipientId? string - Unique identifier of the recipient
pandadoc: DocumentSendManualReminder200ResponseSms
Fields
- sentAt? string? - Timestamp of when the reminder was sent, in ISO 8601 format. Present only on success
- detail? "Can't send reminder to CC recipient"|"Can't send reminder to the Recipient who completed their part"|"Can't send reminder. Signing order is enabled and this Recipient can't sign the document yet"|"Can't send reminder. SMS delivery method is not selected for recipient"|"Can't send SMS reminder to recipient group"|"Can't send SMS reminder. Confirmation of recipient consent is required. Admin should access workspace settings to certify"|"Can't send SMS reminder to the Recipient more than once every 24 hours"|"Can't send SMS reminder to the Recipient with no phone number"|"Can't send SMS reminder to the Recipient with invalid phone number"|"Can't send reminder. The document does not contain a recipient with the specified recipient ID"? - Detailed explanation of why the reminder could not be sent. Present only on error
- status? "sent"|"error" - Status of the SMS reminder attempt (sent or error)
pandadoc: DocumentSendManualReminderRequest
Fields
- reminders? DocumentSendManualReminderRequestReminders[] - A list of reminders to be sent to specified recipients. Use this field to specify which recipients should receive a reminder and through which delivery methods. Each email reminder contains document sender in the From field, ensuring the recipient always sees consistent sender details and branding
pandadoc: DocumentSendManualReminderRequestEmailCustomization
Optional customization settings for the reminder email.
Defines the subject and body text used when sending the reminder via email.
This object is processed only if delivery_methods.email is set to true
Fields
- subject? string? - Subject line of the reminder email sent to the recipient
- message? string? - Custom message body of the reminder email. Can include friendly or contextual text encouraging the recipient to complete the signing process. Supports Markdown syntax for rich text formatting (e.g., bold, italics, links, and line breaks)
pandadoc: DocumentSendManualReminderRequestReminders
Fields
- deliveryMethods? RecipientDeliveryMethods? -
- emailCustomization? DocumentSendManualReminderRequestEmailCustomization -
- recipientId? string - Unique identifier of the recipient to receive the reminder
pandadoc: DocumentSendRequest
Fields
- silent? boolean - If set to
true, disables email notifications for document recipients and the document sender. Also disables scheduled reminders (manual reminders still possible). Doesn't affect "Approve document" email notification sent to the Approver
- replyTo? string - Email address that will be used as a reply-to address for the document. To use this parameter, please contact the support team to have it enabled for your account
- sender? DocumentSendRequestSender - You can set a sender of a document as an
emailormembership_id
- subject? string - Value that will be used as the email subject
- forwardingSettings? DocumentSendRequestForwardingSettings -
- selectedApprovers? DocumentSendRequestSelectedApprovers -
- message? string - A message that will be sent by email with a link to a document to sign
pandadoc: DocumentSendRequestForwardingSettings
Set settings for Document and Signature forwarding
Fields
- forwardingWithReassigningAllowed? boolean - Your recipient will be able/not able to forward the right to fill out all fields (including signature) assigned to them to another email address
- forwardingAllowed? boolean - Your recipient will be able/not able to forward the document to another email address
pandadoc: DocumentSendRequestSelectedApprovers
Configuration for selected approvers
Fields
- steps? DocumentSendRequestSelectedApproversSteps[] - Approval steps
pandadoc: DocumentSendRequestSelectedApproversGroup
Group information
Fields
- assignees DocumentSendRequestSelectedApproversGroupAssignees[] - Assignees for the group
- id string - Group ID
- 'type string - Group type
pandadoc: DocumentSendRequestSelectedApproversGroupAssignees
Fields
- isSelected? boolean - Whether the user is selected
- user? string - User ID
pandadoc: DocumentSendRequestSelectedApproversSteps
Fields
- id string - Step ID
- group DocumentSendRequestSelectedApproversGroup - Group information
pandadoc: DocumentSendRequestSender
You can set a sender of a document as an email or membership_id
Fields
- membershipId? string - Membership ID
- email? string - Email
pandadoc: DocumentSendResponse
Fields
- dateModified? string -
- dateCreated? string -
- recipients? DocumentSendResponseRecipients[] -
- name? string -
- dateCompleted? string? - Document completion date
- id? string -
- expirationDate? string -
- version? string -
- uuid? string -
- status? string -
pandadoc: DocumentSendResponseRecipients
Fields
- recipientType? RecipientTypeEnum -
- deliveryMethods? RecipientDeliveryMethods? -
- phone? string? -
- lastName? string -
- signingOrder? int? -
- sharedLink? string -
- id? string -
- 'type? string? -
- firstName? string -
- email? string? -
pandadoc: DocumentSettingsResponse
Document settings response
Fields
- language DocumentLanguageEnum - Document language code (e.g., 'en-US', 'fr-FR')
- qualifiedElectronicSignature boolean - Indicates whether the document requires a Qualified Electronic Signature (QES)
during the signing process. If
true, signers must complete the document using a third-party qualified electronic signature provider according to supported verification rules
- expiresIn Signed32 - Document expiration in days. If not explicitly set, defaults to the system default expiration
- suggestEdits boolean - Indicates whether Suggest Edits (redlining) is enabled for the document. When
true, recipients can suggest edits to the document content during the signing process
pandadoc: DocumentsFolderCreateRequest
Fields
- parentUuid? string - ID of the parent folder. To create a new folder in the root folder, remove this parameter in the request
- name string - Name the folder for the Documents you are creating
pandadoc: DocumentsFolderCreateResponse
Fields
- dateCreated? string -
- name? string -
- uuid? string -
pandadoc: DocumentsFolderListResponse
Fields
- results? DocumentsFolderListResponseResults[] -
pandadoc: DocumentsFolderListResponseResults
Fields
- hasFolders? boolean -
- dateCreated? string -
- name? string -
- uuid? string -
- hasItems? boolean -
pandadoc: DocumentsFolderRenameRequest
Fields
- name string - Provide a new name for the folder
pandadoc: DocumentsFolderRenameResponse
Fields
- dateCreated? string -
- name? string -
- uuid? string -
pandadoc: DocumentStatusChangeRequest
Fields
- note? string - Provide “private notes” regarding the manual status change
- notifyRecipients? boolean - Send a notification email about the status change to all recipients
- status DocumentStatusChangeRequestStatusEnum - Number code for the target document status. See notes for the codes corresponding to each status
pandadoc: DocumentStatusResponse
Fields
- dateModified? string? -
- dateCreated? string -
- name? string -
- dateCompleted? string? -
- id? string -
- expirationDate? string? -
- version? string? -
- uuid? string -
- status? string -
pandadoc: DocumentTransferAllOwnershipRequest
Fields
- silent boolean(default false) - If set to
true, disables the email and in-app notifications about the ownership transfer that are sent to the new documents owner
- fromMembershipId? string - A unique identifier of a workspace member from whom you want to transfer ownership
- toMembershipId? string - A unique identifier of a workspace member to whom you want to transfer ownership
pandadoc: DocumentTransferOwnershipRequest
Fields
- silent boolean(default false) - If set to
true, disables the email and in-app notifications about the ownership transfer that are sent to the new document owner
- membershipId? string - A unique identifier of a workspace member
pandadoc: DocumentUpdateRequest
Fields
- metadata? record {} - You can pass arbitrary data in the key-value format to associate custom information with a document. This information is returned in any API requests for the document details by id. If metadata exists in a document then the value will be updated. Otherwise, metadata will be added to the document
- tables? TableRequest[] -
- images? DocumentUpdateRequestImages[] - You can pass a list of images to image blocks (one image in one block) for replacement
- texts? DocumentUpdateRequestTexts[] - You can pass a list of texts to text blocks for replacement
- recipients? UpdateDocumentActor[] - The list of recipients you're sending the document to. The ID or email are required. If the ID is passed, an existing recipient will be updated. If the email is passed, a new recipient will be added to CC
- name? string - The name of the document
- pricingTables? PricingTableRequest[] -
- tokens? DocumentUpdateRequestTokens[] - Create or initialize multiple variables with their values using tokens/values list
- fields? DocumentUpdateRequestField - Set specific values to the fields. This object maps merge field names to their corresponding values.
Each key represents a merge field name, and each value is an object containing the data to populate that field with. The structure allows you to pre-populate various field types including text inputs, checkboxes, dropdowns, and date fields.
Key Points:
- Keys must match the exact merge field names from your template or file.
- Values must be wrapped in an object with a
valueproperty. - Supported value types: string, number, boolean.
- Date fields should use RFC 3339 format (e.g., '2019-12-31T00:00:00.000Z').
- Signature fields cannot be pre-filled.
- Text field:
"CustomerName": {"value": "John Doe"} - Checkbox:
"AgreeToTerms": {"value": true} - Date field:
"DeliveryDate": {"value": "2019-12-31T00:00:00.000Z"}
- tags? string[] - Mark your document with one or several tags
pandadoc: DocumentUpdateRequestField
Set specific values to the fields. This object maps merge field names to their corresponding values.
Each key represents a merge field name, and each value is an object containing the data to populate that field with. The structure allows you to pre-populate various field types including text inputs, checkboxes, dropdowns, and date fields.
Key Points:
- Keys must match the exact merge field names from your template or file.
- Values must be wrapped in an object with a
valueproperty. - Supported value types: string, number, boolean.
- Date fields should use RFC 3339 format (e.g., '2019-12-31T00:00:00.000Z').
- Signature fields cannot be pre-filled.
Example Usage:
- Text field:
"CustomerName": {"value": "John Doe"} - Checkbox:
"AgreeToTerms": {"value": true} - Date field:
"DeliveryDate": {"value": "2019-12-31T00:00:00.000Z"}
Fields
pandadoc: DocumentUpdateRequestImages
Fields
- urls string[] -
- name string -
pandadoc: DocumentUpdateRequestTexts
Fields
- data string - The rich text content to be inserted into the block. Supports markdown
- name string - The name of the text block to update
pandadoc: DocumentUpdateRequestTokens
Fields
- name string -
- value string -
pandadoc: DocxExportTaskResponse
Fields
- Fields Included from *DocumentDocxExport
- id string
- documentId string
- status DocumentDocxExportStatusEnum
- anydata...
- docxItems? DocxExportTaskResponse_docx_items[] - DOCX files result URLs with their names
pandadoc: DocxExportTaskResponse_docx_items
List of download links and section item titles of the document.
Fields
- sectionTitle? string? - Document Section Item title.
- url? string? - The url for downloading the DOCX file.
pandadoc: DownloadDocumentQueries
Represents the Queries record for the operation: downloadDocument
Fields
- watermarkOpacity? float - In range 0.0-1.0
- watermarkColor? string - HEX code (for example
#FF5733)
- watermarkFontSize? int - Font size of the watermark
- separateFiles boolean(default false) - Download document bundle as a zip-archive of separate PDFs (1 file per section)
- watermarkText? string - Specify watermark text
pandadoc: DownloadProtectedDocumentQueries
Represents the Queries record for the operation: downloadProtectedDocument
Fields
- separateFiles boolean(default false) - Download document bundle as a zip-archive of separate PDFs (1 file per section)
pandadoc: Dropdown
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "dropdown" -
- value? string - Value of the Dropdown field
- mergeField? string -
pandadoc: EditingSessionRequest
Fields
- lifetime Signed32(default 3600) - Lifetime of the E-Token in seconds
- email string - Email of the user to create the editing session for
pandadoc: FormListResponse
Fields
- hasNextPage? boolean -
- results? FormListResponseResults[] -
pandadoc: FormListResponseResults
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- id? string -
- status? string -
pandadoc: GetUserResponse
Fields
- license? string - A user's license in the organization
- userId? string - A unique identifier of the user in the organization
- lastName? string - A user's last name
- phoneNumber? string - A user's phone number
- isOrganizationOwner? boolean - Whether the user is the owner of the organization
- workspaces? GetUserResponseWorkspaces[] -
- firstName? string - A user's first name
- email? string - A user's email address
pandadoc: GetUserResponseWorkspaces
Fields
- workspaceId? string - A user's workspace
- role? WorkspaceMemberRoleEnum - Role for a member
- membershipId? string - A user's membership id in workspace
pandadoc: Initials
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "initials" -
- value? record {} - Value of the Initials field. Always empty object
pandadoc: LinkedObjectChild
Child entity reference in a hierarchical chain structure that provides essential metadata and direct access links for lazy-loading the complete object by ID
Fields
- entityType? string - Entity type. See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- id? string - Linked object identifier (link_id)
- entityId? string - Entity unique identifier. The system validates if the entity exists
pandadoc: LinkedObjectCreateRequest
Fields
- entityType string - Entity type. See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- provider string - CRM name (lowercase). See the list of available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- entityId string - Entity unique identifier. The system validates if the entity exists
pandadoc: LinkedObjectCreateResponse
Fields
- entityType? string - Entity type. See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- provider? string - CRM name (lowercase). See the list of available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- children? LinkedObjectChild[] -
- id? string - Linked object identifier (link_id)
- entityId? string - Entity unique identifier. The system validates if the entity exists
pandadoc: LinkedObjectListResponse
Fields
- linkedObjects? LinkedObjectCreateResponse[] -
pandadoc: ListCatalogItemsSearchResponse
Fields
- total? decimal -
- hasMoreItems? boolean -
- items? ProductCatalogSearchCatalogItemResponse[] -
pandadoc: ListContactsQueries
Represents the Queries record for the operation: listContacts
Fields
- email? string - Optional search parameter. Filter results by exact match
pandadoc: ListContentLibraryItemsQueries
Represents the Queries record for the operation: listContentLibraryItems
Fields
- q? string - Search query. Filter by content library item name
- deleted? boolean - Returns only the deleted content library items
- folderUuid? string - The UUID of the folder where the content library items are stored
- count? Signed32 - Specify how many content library items to return. Default is 50 content library items, maximum is 100 content library items
- id? string - Specify content library item ID
- page? Signed32 - Specify which page of the dataset to return
- tag? string - Search tag. Filter by content library item tag
pandadoc: ListDocumentAuditTrailQueries
Represents the Queries record for the operation: listDocumentAuditTrail
Fields
- offset int(default 0) - Number of items to skip before starting to collect the result set
- 'limit int(default 20) - Maximum number of items to return
pandadoc: ListDocumentFieldsResponse
Fields
- fields? DocumentFieldsField[] -
pandadoc: ListDocumentFoldersQueries
Represents the Queries record for the operation: listDocumentFolders
Fields
- parentUuid? string - The UUID of the folder containing folders. To list the folders located in the root folder, remove this parameter in the request
- count Signed32(default 50) - Optionally, specify how many folders to return
- page? Signed32 - Optionally, specify which page of the dataset to return
pandadoc: ListDocumentsByLinkedObjectQueries
Represents the Queries record for the operation: listDocumentsByLinkedObject
Fields
- entityType string - See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- provider string - See the available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms
- orderBy string(default "-date_created") - Field to sort the results by. Prefix with
-for descending order
- entityId string - You can get entity id from your integration, for example, from a url of a HubSpot deal
- ownerIds string[](default ["[]"]) - Return only documents owned by these users
pandadoc: ListDocumentsByLinkedObjectsResponseInner
Fields
- dateCreated? string -
- templateId? string -
- id? string -
- status? string -
pandadoc: ListDocumentsQueries
Represents the Queries record for the operation: listDocuments
Fields
- metadata? string[] - Filters documents by metadata. Pass metadata in the format of
metadata_{metadata-key}={metadata-value}such asmetadata_opportunity_id=2181432. Themetadata_prefix is always required
- modifiedTo? string - Limits results to the documents with the
date_modifiedless than this value
- statusNe? DocumentStatusRequestEnum - Exludes documents with this status.
- 0: document.draft
- 1: document.sent
- 2: document.completed
- 3: document.uploaded
- 4: document.error
- 5: document.viewed
- 6: document.waiting_approval
- 7: document.approved
- 8: document.rejected
- 9: document.waiting_pay
- 10: document.paid
- 11: document.voided
- 12: document.declined
- 13: document.external_review
- 14: document.scheduled
- membershipId? string - Filter documents by the owner's 'membership_id'
- formId? string - Filters by parent form. This parameter can't be used with template_id
- count? int - Limits the size of the response. Default is 50 documents, maximum is 100 documents
- modifiedFrom? string - Limits results to the documents with the
date_modifiedgreater than or equal to this value
- contactId? string - Filters by recipient or approver with this 'contact_id'
- createdTo? string - Limits results to the documents with the
date_createdless than this value
- completedFrom? string - Limits results to the documents with the
date_completedgreater than or equal to this value
- q? string - Filters documents by name or reference number (stored on the template level)
- deleted? boolean - Returns only the deleted documents
- folderUuid? string - Filters by the folder where the documents are stored
- orderBy? DocumentOrderingFieldsEnum - Defines the sorting of the result. Use
date_createdfor ASC and-date_createdfor DESC sorting
- completedTo? string - Limits results to the documents with the
date_completedless than this value
- templateId? string - Filters by parent template. This Parameter can't be used with form_id
- page? int - Paginates the search result. Increase value to get the next page of results
- id? string - Searches for document by it's id.
- tag? string - Filters documents by tag
- createdFrom? string - Limits results to the documents with the
date_createdgreater than or equal to this value
- status? DocumentStatusRequestEnum - Filters documents by the status.
- 0: document.draft
- 1: document.sent
- 2: document.completed
- 3: document.uploaded
- 4: document.error
- 5: document.viewed
- 6: document.waiting_approval
- 7: document.approved
- 8: document.rejected
- 9: document.waiting_pay
- 10: document.paid
- 11: document.voided
- 12: document.declined
- 13: document.external_review
- 14: document.scheduled
pandadoc: ListFormsQueries
Represents the Queries record for the operation: listForms
Fields
- asc? boolean - Specify sorting the result-set in ascending or descending order
- count? Signed32 - Specify how many forms to return. Default is 50 forms, maximum is 100 forms
- name? string - Specify the form name
- orderBy? "name"|"responses"|"status"|"created_date"|"modified_date" - Specify the form dataset order to return
- page? Signed32 - Specify which page of the dataset to return
- status? ("draft"|"active"|"disabled")[] - Specify which status of the forms dataset to return
pandadoc: ListLogsQueries
Represents the Queries record for the operation: listLogs
Fields
- search? string - Returns the results containing a string
- methods? ApiLogMethodEnum[] - Returns only the predefined HTTP methods. Allows GET, POST, PUT, PATCH, and DELETE
- count Signed32(default 100) - The amount of items on each page. The total number of accessible items (
count × page) must not exceed 10,000
- statuses? ApiLogStatusEnum[] - Returns only the predefined status codes
- to? string - Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as "-10d" (for past 10 days) or a special "now" value
- page Signed32(default 1) - Returns page of the results by number. The total number of accessible items (
count × page) must not exceed 10,000
- environmentType? ApiLogEnvironmentTypeEnum - Returns logs for production/sandbox
- since string(default "-90d") - Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as "-90d" (for past 90 days)
pandadoc: ListLogsV2Queries
Represents the Queries record for the operation: listLogsV2
Fields
- search? string - Returns the results containing a string
- methods? ApiLogMethodEnum[] - Returns only the predefined HTTP methods. Allows GET, POST, PUT, PATCH, and DELETE
- count Signed32(default 100) - The amount of items on each page. The total number of accessible items (
count × page) must not exceed 10,000
- statuses? ApiLogStatusEnum[] - Returns only the predefined status codes
- to? string - Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as "-10d" (for past 10 days) or a special "now" value
- page Signed32(default 1) - Returns page of the results by number. The total number of accessible items (
count × page) must not exceed 10,000
- environmentType? ApiLogEnvironmentTypeEnum - Returns logs for production/sandbox
- since string(default "-90d") - Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as "-90d" (for past 90 days)
pandadoc: ListNotariesQueries
Represents the Queries record for the operation: listNotaries
Fields
- offset int(default 0) - Number of results to skip
- 'limit int(default 50) - Maximum number of results to return
- commissionState? ListNotariesQueriesCommissionstateItemsString[] - Filter by commission state (comma-separated values supported)
- orderBy "email"|"-email"|"status"|"-status"|"name"|"-name" (default "email") - Sort by name, email, or status (default is email). Use a - prefix for descending order (e.g., -email)
- status? ("INVITED"|"UNDER_REVIEW"|"ACTIVE"|"REJECTED"|"INACTIVE")[] - Filter by status (comma-separated values supported). Valid values are INVITED, UNDER_REVIEW, ACTIVE, REJECTED, INACTIVE
pandadoc: ListNotariesResponse
Fields
- count? int - Total number of notaries matching the criteria
- results? ListNotariesResponseResults[] - Array of notary objects
pandadoc: ListNotariesResponseResults
Fields
- name? string? - Full name of the notary
- commissionState? string? -
- id? string - Unique identifier for the notary
- email? string - Email address of the notary
- status? "INVITED"|"UNDER_REVIEW"|"ACTIVE"|"REJECTED"|"INACTIVE" - Current status of the notary
pandadoc: ListNotarizationRequestsQueries
Represents the Queries record for the operation: listNotarizationRequests
Fields
- offset int(default 0) - Number of results to skip
- 'limit int(default 50) - Maximum number of results to return
- orderBy "status"|"-status"|"date_created"|"-date_created"|"date_completed"|"-date_completed" (default "date_created") - Sort field. Use a
-prefix for descending order (e.g.,-date_created). When omitted, results are sorted bydate_createdascending (oldest first)
- documentId? string[] - Filter by document ID (comma-separated values supported)
- createdByUserId? string[] - Filter by creator user ID (comma-separated values supported)
- status? ("DRAFT"|"SENT"|"WAITING_FOR_NOTARY"|"ACCEPTED"|"LIVE"|"COMPLETED"|"INCOMPLETE"|"CANCELLED")[] - Filter by status (comma-separated values supported)
pandadoc: ListNotarizationRequestsResponse
Fields
- count? int - Total number of notarization requests matching the criteria
- results? ListNotarizationRequestsResponseResults[] - Array of notarization request objects
pandadoc: ListNotarizationRequestsResponseResults
Fields
- dateCreated? string - A date when a notarization request was created
- name? string - Name of the notarization request
- dateCompleted? string? - A date when a notarization session was completed
- id? string - A unique identifier of the notarization request
- documentId? string - A unique identifier of the document for notarization
- createdByUserId? string - Public user id of the request creator
- dateStarted? string? - A date when a notarization session was started
- status? "DRAFT"|"SENT"|"WAITING_FOR_NOTARY"|"ACCEPTED"|"LIVE"|"COMPLETED"|"INCOMPLETE"|"CANCELLED" - Current status of the notarization request
pandadoc: ListRecentSmsOptOutsQueries
Represents the Queries record for the operation: listRecentSmsOptOuts
Fields
- timestampTo? string - The end of the timestamp range. If no timestamp is provided the current time will be used
- timestampFrom? string - The start of the timestamp. If no timestamp is provided, 1 hour before the current time will be used
pandadoc: ListSmsOptOutChangelogResponse
Fields
- results? ListSmsOptOutChangelogResponseResults[] -
pandadoc: ListSmsOptOutChangelogResponseResults
Fields
- optOutChanged? string -
- phoneNumber? string -
- status? "opt-in"|"opt-out" -
pandadoc: ListTemplateFoldersQueries
Represents the Queries record for the operation: listTemplateFolders
Fields
- parentUuid? string - The UUID of the folder containing folders. To list the folders located in the root folder, remove this parameter in the request
- count Signed32(default 50) - Optionally, specify how many folders to return
- page? Signed32 - Optionally, specify which page of the dataset to return
pandadoc: ListTemplatesQueries
Represents the Queries record for the operation: listTemplates
Fields
- q? string - Search query. Filter by template name
- shared? boolean - Returns only the shared templates
- deleted? boolean - Returns only the deleted templates
- folderUuid? string - UUID of the folder where the templates are stored
- count Signed32(default 50) - Specify how many templates to return
- page? Signed32 - Specify which page of the dataset to return
- id? string - Specify template ID
- tag? string[] - Search tag. Filter by template tag
- fields? ("content_date_modified")[] - A comma-separated list of additional fields to include in the response
pandadoc: ListUsersQueries
Represents the Queries record for the operation: listUsers
Fields
- count Signed32(default 50) - Number of elements in page
- page Signed32(default 1) - Page number
- showRemoved boolean(default true) - Filter option - show users with removed memberships
pandadoc: ListUsersResponse
Fields
- total? int - A number of users
- results? ListUsersResponseResults[] -
pandadoc: ListUsersResponseResults
Fields
- license? string - A user's license in the organization
- userId? string - A unique identifier of the user in the organization
- lastName? string - A user's last name
- phoneNumber? string - A user's phone number
- isOrganizationOwner? boolean - Whether the user is the owner of the organization
- workspaces? ListUsersResponseWorkspaces[] -
- firstName? string - A user's first name
- email? string - A user's email address
pandadoc: ListUsersResponseWorkspaces
Fields
- workspaceId? string - A user's workspace
- role? string - A user's role in workspace
- membershipId? string - A user's membership id in workspace
pandadoc: ListWebhookEventsQueries
Represents the Queries record for the operation: listWebhookEvents
Fields
- httpStatusCode? WebhookEventHttpStatusCodeGroupEnum[] - Returns results with the specified HTTP status codes
- count Signed32 - Specify how many event results to return
- page Signed32 - Specify which page of the dataset to return
- to? string - Return results where the event creation time is less than this value
- 'type? WebhookEventTriggerEnum[] - Returns results by the specified event types
- 'error? WebhookEventErrorEnum[] - Returns results with the following errors
- since? string - Return results where the event creation time is greater than or equal to this value
pandadoc: ListWorkspacesQueries
Represents the Queries record for the operation: listWorkspaces
Fields
- q? string - Filters workspaces by name (case-insensitive)
- count Signed32(default 50) - Number of elements in page
- page Signed32(default 1) - Page number
pandadoc: ListWorkspacesResponse
Fields
- total? int - A number of workspaces
- results? ListWorkspacesResponseResults[] -
pandadoc: ListWorkspacesResponseResults
Fields
- owner? string - A owner's email address
- dateCreated? string - A workspace's date creation
- name? string - A workspace's name
- id? string - A unique identifier of a workspace in a organization
pandadoc: MemberDetailsResponse
Fields
- workspace? string - A unique identifier of the user's current active workspace
- isActive? boolean - A boolean value that identifies if a member is active in the workspace
- role? string - A member's role in the workspace
- dateCreated? string - A date when a member was added to the workspace
- membershipId? string - A unique identifier of the user in the workspace
- lastName? string - A user's last name
- userLicense? string - A user license in the organization
- emailsVerified? boolean - A boolean value that identifies if the email is verified
- dateModified? string - Last modified date of a member
- userId? string - A unique identifier of the user in the organization
- firstName? string - A user's first name
- email? string - A user's email address
- workspaceName? string - A name of the user's current active workspace
pandadoc: MemberListResponse
Fields
- results? MemberDetailsResponse[] -
pandadoc: NotarizationRequestDetailsResponse
Fields
- invitees? NotarizationRequestDetailsResponseInvitees[] -
- dateCreated? string - A date when a notarization request was created
- terminationReason? "SIGNER_NO_SHOW"|"AUDIO_VIDEO_ISSUE"|"FAILED_IDENTITY_VERIFICATION"|"TEST_SESSION"|"OTHER"? - The reason why the notarization session was terminated. Only present when the request status is INCOMPLETE
- dateCompleted? string? - A date when a notarization session was completed
- recording? NotarizationRequestDetailsResponseRecording? -
- id? string - A unique identifier of the notarization request
- documentId? string - A unique identifier of the document for notarization
- createdBy? NotarizationRequestDetailsResponseCreatedBy -
- signedDocuments? NotarizationRequestDetailsResponseSignedDocuments[] -
- dateStarted? string? - A date when a notarization session was started
- status? "DRAFT"|"SENT"|"WAITING_FOR_NOTARY"|"ACCEPTED"|"LIVE"|"COMPLETED"|"INCOMPLETE"|"CANCELLED" - Current status of the notarization request
- terminationDetails? string? - Additional details about the termination reason provided by the notary. Only present when the request status is INCOMPLETE
pandadoc: NotarizationRequestDetailsResponseCreatedBy
Fields
- userId? string - A unique identifier of the user who created a notarization request
- lastName? string - A user's last name
- firstName? string - A user's first name
- email? string - A user's email address
pandadoc: NotarizationRequestDetailsResponseInvitees
Fields
- lastName? string? - A invitee's last name
- id? string - A unique identifier of the invitee
- firstName? string? - A invitee's first name
- email? string - A invitee's email address
pandadoc: NotarizationRequestDetailsResponseRecording
Fields
- size? decimal - Size of the video recording file in bytes
- name? string - Name of the video recording file
- url? string - Secure URL to download video recording of the notarization session
pandadoc: NotarizationRequestDetailsResponseSignedDocuments
Fields
- documentName? string - A signer document name
- size? decimal - A signer document size in bytes
- url? string - Secure URL to download signed PDF document
- documentType? "COMBINED"|"SINGLE" - A type of the signed document
pandadoc: OAuth2AccessTokenResponse
Fields
- accessToken? string -
- refreshToken? string -
- scope? string - Granted permissions.
read,write, or space-separatedread write.read+writeis deprecated
- tokenType? string -
- expiresIn? decimal -
pandadoc: OAuth2CreateAccessTokenRequest
Fields
- code string -
auth_codefrom the server on the previous step (Authorize a PandaDoc User)
- grantType string(default "authorization_code") - This value must be set to
authorization_code
- scope? "read"|"write"|"read write" - Requested permissions. Use
readto view templates and document details,writeto create, send, delete, and download documents, orread writefor both.read+writeis deprecated; useread write
- clientSecret string - Client secret that is automatically generated after application creation in the Developer Dashboard
- clientId string - Client ID that is automatically generated after application creation in the Developer Dashboard
pandadoc: OAuth2RefreshAccessTokenRequest
Fields
- refreshToken string -
refresh_tokenyou received and stored from the server when initially creating anaccess_token
- grantType string(default "refresh_token") - This value must be set to
refresh_token
- scope? "read"|"write"|"read write" - Requested permissions. Use
read writeas the default value to send documents.read+writeis deprecated; useread write
- clientSecret string - Client secret that is automatically generated after application creation in the Developer Dashboard
- clientId string - Client ID that is automatically generated after application creation in the Developer Dashboard
pandadoc: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://api.pandadoc.com/oauth2/access_token") - Refresh URL
pandadoc: Payment
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "payment_details" -
- value? string - Value of the Payment field. Always empty string
pandadoc: PricingResponse
Fields
- tables? PricingTableResponse[] -
- total? string -
- quotes? QuoteResponse[] -
pandadoc: PricingTableRequest
Fields
- name string -
- options? record {} -
- dataMerge? boolean - When set to true all field names in data rows must be passed as external names defined in the template
- sections PricingTableRequestSections[] -
pandadoc: PricingTableRequestRowOptions
Fields
- qtyEditable? boolean -
- optionalSelected? boolean -
- optional? boolean -
pandadoc: PricingTableRequestRows
Fields
- data record {} -
- customFields? record {} -
- options PricingTableRequestRowOptions -
pandadoc: PricingTableRequestSections
Fields
- default boolean -
- title string -
- rows? PricingTableRequestRows[] -
- multichoiceEnabled boolean(default false) -
pandadoc: PricingTableResponse
Fields
- summary? PricingTableResponseSummary? -
- total? string -
- name? string -
- currency? string -
- id? string -
- isIncludedInTotal? boolean -
- items? PricingTableResponseItems[] -
pandadoc: PricingTableResponseDiscount
Fields
- 'type? string? -
- value? string? -
pandadoc: PricingTableResponseItems
Fields
- fees? record {}? -
- cost? string? -
- taxSecond? PricingTableResponseDiscount? -
- customFields? record {}? -
- description? string? -
- discount? PricingTableResponseDiscount? -
- taxes? record {}? -
- salePrice? string? -
- mergedData? record {}? - Contains all fields in a flat structure with external field names defined in the template
- customColumns? record {}? -
- discounts? record {}? -
- price? string? -
- subtotal? string? -
- qty? string? -
- taxFirst? PricingTableResponseDiscount? -
- name? string? -
- options? PricingTableResponseOptions? -
- id? string? -
- sku? string? -
pandadoc: PricingTableResponseOptions
Fields
- qtyEditable? boolean -
- optionalSelected? boolean? -
- multichoiceSelected? boolean? -
- optional? boolean? -
- multichoiceEnabled? boolean? -
pandadoc: PricingTableResponseSummary
Fields
- total? string? -
- subtotal? string? -
- fee? string? -
- discount? string? -
- tax? string? -
pandadoc: PrivacySettings
Effective privacy settings for a workspace. Compliance flags and on-premises training are read-only on this API
Fields
- workspaceId string - Workspace id
- aiFeaturesEnabled boolean - Master switch for AI features in the workspace
- aiOnPremisesTrainingEnabled boolean - Whether PandaDoc-operated model training is enabled
- aiThirdPartyTrainingEnabled boolean - Whether third-party model training is enabled
- cfr11ComplianceEnabled boolean - Whether 21 CFR Part 11 compliance is enabled for the workspace
- hipaaComplianceEnabled boolean - Whether HIPAA compliance is enabled for the workspace. When
true, every AI setting is forced off
- aiOnPremisesProcessingEnabled boolean - Whether PandaDoc-operated AI processing is enabled
- aiCloudThirdPartyEnabled boolean - Whether third-party cloud AI processing is enabled
pandadoc: ProductCatalogCatalogCustomBundleItem
Fields
- images? ProductCatalogSearchCatalogItemResponseImages[]? -
- imageUrl? string? -
- priceConfiguration? ProductCatalogItemPriceConfiguration -
- description? string? -
- title? string -
- uuid? string -
pandadoc: ProductCatalogCatalogItemInBundle
Fields
- images? ProductCatalogSearchCatalogItemResponseImages[]? -
- imageUrl? string? -
- price? decimal? -
- description? string? -
- currency? string -
- title? string -
- sku? string? -
- uuid? string -
pandadoc: ProductCatalogCustomBundleItemNoId
Fields
- images? ProductCatalogSearchCatalogItemResponseImages[]? -
- imageUrl? string? -
- price? decimal? -
- description? string? -
- currency? string -
- title? string -
- sku? string? -
pandadoc: ProductCatalogCustomCatalogItemInBundle
Fields
- images? ProductCatalogSearchCatalogItemResponseImages[]? -
- imageUrl? string? -
- price? decimal? -
- description? string? -
- currency? string -
- title? string -
- uuid? string -
pandadoc: ProductCatalogItemPatchRequest
Fields
- categoryId? string? -
- productVariant? ProductCatalogItemPatchRequestProductVariant -
- title? string -
- 'type? ProductCatalogTypeEnum -
- bundleItems? ProductCatalogItemPatchRequestBundleItems[]? -
pandadoc: ProductCatalogItemPatchRequestBundleItems
Fields
- quantity? int -
- itemOrUuid? string|ProductCatalogCustomBundleItemNoId -
pandadoc: ProductCatalogItemPatchRequestProductVariant
Fields
- images? ProductCatalogItemRequestImages[]? -
- customFields? ProductCatalogSearchCatalogItemResponseCustomFields[]? -
- priceConfiguration? ProductCatalogItemPriceConfiguration -
- description? string? -
- sku? string? -
pandadoc: ProductCatalogItemPriceConfiguration
Fields
- tiers? ProductCatalogItemPriceTier[]? - only for volume based pricing
- cost? decimal? -
- price? decimal? -
- billingType? string -
- currency string -
- billingCycle? string? -
- pricingMethod ProductCatalogPricingMethodEnum -
pandadoc: ProductCatalogItemPriceTier
Fields
- minQty decimal -
- value float -
pandadoc: ProductCatalogItemRequest
Fields
- images? ProductCatalogItemRequestImages[]? -
- categoryId? string? -
- customFields? ProductCatalogItemRequestCustomFields[]? -
- priceConfiguration ProductCatalogItemPriceConfiguration -
- description? string? -
- title string -
- sku? string? -
- 'type? ProductCatalogTypeEnum -
- bundleItems? ProductCatalogItemRequestBundleItems[]? -
pandadoc: ProductCatalogItemRequestBundleItems
Fields
- quantity? int -
- itemOrUuid? string|ProductCatalogCatalogCustomBundleItem -
pandadoc: ProductCatalogItemRequestCustomFields
Fields
- name? string -
- value? string -
pandadoc: ProductCatalogItemRequestImages
Fields
- src? string -
- isMain? boolean -
- 'order? decimal -
pandadoc: ProductCatalogItemResponse
Fields
- categoryName? string? -
- dateModified? string? -
- categoryId? string? -
- dateCreated? string -
- modifiedBy? string? -
- variants? ProductCatalogItemResponseVariants[] -
- title? string -
- 'type? ProductCatalogTypeEnum -
- bundleItems? ProductCatalogItemResponseBundleItems[]? -
- uuid? string -
- createdBy? string -
pandadoc: ProductCatalogItemResponseBundleItems
Fields
- quantity? int -
pandadoc: ProductCatalogItemResponsePriceConfigurations
Fields
- Fields Included from *ProductCatalogItemPriceConfiguration
- tiers ProductCatalogItemPriceTier[]|()
- cost decimal|()
- price decimal|()
- billingType string
- currency string
- billingCycle string|()
- pricingMethod ProductCatalogPricingMethodEnum
- anydata...
- uuid? string -
pandadoc: ProductCatalogItemResponseVariants
Fields
- images? ProductCatalogSearchCatalogItemResponseImages[]? -
- dateModified? string? -
- customFields? ProductCatalogSearchCatalogItemResponseCustomFields[]? -
- dateCreated? string -
- description? string? -
- priceConfigurations? ProductCatalogItemResponsePriceConfigurations[] -
- sku? string? -
- uuid? string -
- status? decimal -
pandadoc: ProductCatalogSearchCatalogItemResponse
Fields
- tiers? ProductCatalogSearchCatalogItemResponseTiers[]? -
- categoryName? string? -
- description? string? -
- title? string -
- 'type? ProductCatalogTypeEnum -
- uuid? string -
- workspaceId? string -
- categoryId? string? -
- price? decimal? -
- billingType? string -
- currency? string -
- billingCycle? int? -
- sku? string -
- bundleItemsCount? int -
- images? ProductCatalogSearchCatalogItemResponseImages[]? -
- cost? decimal? -
- customFields? ProductCatalogSearchCatalogItemResponseCustomFields[]? -
- dateCreated? string -
- createdBy? string -
- imageSrc? string? -
- highlights? record { record {}... }? -
- dateModified? string? -
- modifiedBy? string -
- maxTierValue? decimal? -
- minTierValue? decimal? -
- pricingMethod? int -
pandadoc: ProductCatalogSearchCatalogItemResponseCustomFields
Fields
- name? string -
- value? string? -
pandadoc: ProductCatalogSearchCatalogItemResponseImages
Fields
- src? string -
- isMain? boolean? -
- 'order? decimal -
pandadoc: ProductCatalogSearchCatalogItemResponseTiers
Fields
- minQty? decimal -
- value? decimal -
pandadoc: QuoteResponse
Fields
- summary? QuoteResponseSummary -
- settings? QuoteResponseSettings -
- total? string -
- currency? string -
- id? string -
- mergeRules? QuoteResponseMergeRules[] -
- sections? QuoteResponseSections[] -
pandadoc: QuoteResponseAction
Fields
- sectionId? string -
- 'type? string -
pandadoc: QuoteResponseCondition
Fields
- comparison? QuoteResponseConditionComparison[] -
- 'type? string -
- fieldName? string -
pandadoc: QuoteResponseConditionComparison
Fields
- 'type? string -
- value? string -
pandadoc: QuoteResponseMergeRules
Fields
- condition? QuoteResponseCondition -
- action? QuoteResponseAction -
- id? string -
- enabled? boolean -
pandadoc: QuoteResponseOptions
Fields
- qtyEditable? boolean? -
- selected? boolean? -
pandadoc: QuoteResponseSectionColumn
Fields
- hidden? boolean -
- mergeName? string? -
- name? string -
- header? string? -
pandadoc: QuoteResponseSectionItem
Fields
- fees? record { QuoteResponseSummaryDiscounts... }? -
- referenceId? string? -
- description? string? -
- taxes? record { QuoteResponseSummaryDiscounts... }? -
- contractTerm? string? -
- 'type? string? -
- total? string? -
- mergedData? record {}? -
- discounts? record { QuoteResponseSummaryDiscounts... }? -
- price? string? -
- options? QuoteResponseOptions? -
- multipliers? record { string... }? -
- id? string? -
- sku? string? -
- thumbnail? string? -
- images? string[]? -
- cost? string? -
- totalQty? string? -
- referenceType? string? -
- billingFrequency? QuoteUpdateRequestBillingFrequencyEnum? -
- overallTotal? string? -
- customColumns? record { string... }? -
- qty? string? -
- name? string? -
- externalColumns? record { string... } -
- pricingMethod? string? -
pandadoc: QuoteResponseSections
Fields
- summary? QuoteResponseSectionSummary -
- settings? QuoteSectionSettings -
- total? string -
- columns? QuoteResponseSectionColumn[] -
- name? string -
- id? string -
- items? QuoteResponseSectionItem[]? -
pandadoc: QuoteResponseSectionSummary
Fields
- total? string -
- fees? record {}? -
- discounts? record {}? -
- subtotal? string? -
- customFields? record { string... }? -
- totalQty? string? -
- taxes? record {}? -
- totalSectionValue? string? -
- recurringSubtotal? QuoteResponseSummaryRecurringSubtotal[]? -
- oneTimeSubtotal? string? -
pandadoc: QuoteResponseSettings
Fields
- selectionType? "custom"|"single"|"multiple" -
pandadoc: QuoteResponseSummary
Fields
- fees? record {}? -
- totalDiscount? string? -
- customFields? record { string... }? -
- totalQty? string? -
- taxes? record {}? -
- recurringSubtotal? QuoteResponseSummaryRecurringSubtotal[]? -
- totalTax? string? -
- total? string -
- discounts? record { QuoteResponseSummaryDiscounts... }? -
- totalSavings? string? -
- subtotal? string? -
- totalFee? string? -
- oneTimeSubtotal? string? -
- totalContractValue? string? -
pandadoc: QuoteResponseSummaryDiscounts
Fields
- 'type? string? -
- value? string? -
pandadoc: QuoteResponseSummaryRecurringSubtotal
Fields
- billingCycle? string -
- value? string -
pandadoc: QuotesBatchUpdateItem
A single quote update within the batch. Same shape as the single-quote update request (QuoteUpdateRequest), with an added id identifying which quote this entry applies to
Fields
- id string - ID of the quote to update
- Fields Included from *QuoteUpdateRequest
- summary QuoteUpdateRequestSummary
- settings QuoteUpdateRequestSelectionSettings
- currency string
- sections UpdateIntegrationQuoteSection[]
- anydata...
pandadoc: QuotesBatchUpdateRequest
Batch request to update multiple quotes within a single document
Fields
- quotes QuotesBatchUpdateItem[] - Quotes to update within this document. Each entry is processed independently — see the operation description for the partial-success model. Duplicate
idvalues are not allowed
pandadoc: QuotesBatchUpdateResponse
Per-quote update outcomes. Always returned with HTTP 200 when the request itself is valid; per-quote failures are reported in results[].status
Fields
- count int - Number of entries in
results. Equal to the number ofquotesin the request
- results QuotesBatchUpdateResult[] - Per-quote outcomes, in the same order as the request's
quotes. Each entry's shape depends on itsstatus
pandadoc: QuotesBatchUpdateResultBase
Fields common to every per-quote outcome in a batch quotes update response
Fields
- id string - The quote this result corresponds to. Echoed from the request
- status QuotesBatchUpdateResultStatus - Per-quote outcome discriminator.
ok,validation_error,not_in_document,not_found, andconflictmirror the single-quote update endpoint's200/400/403/404/409responses respectively — see each variant's own schema.internal_erroris exclusive to the batch endpoint and indicates an isolated server-side failure for that quote only; the request as a whole succeeded and other quotes in the same batch are unaffected
pandadoc: QuotesBatchUpdateResultConflict
Mirrors the single-quote endpoint's 409 response. The quote was modified concurrently since the version you have; fetch the latest version and retry
Fields
- Fields Included from *QuotesBatchUpdateResultBase
- id string
- status QuotesBatchUpdateResultStatus
- anydata...
- description string - Human-readable explanation of the conflict
- status? "conflict" - Result status for this quote. Always
conflict
pandadoc: QuotesBatchUpdateResultInternalError
An isolated server-side failure occurred for this quote. The request as a whole succeeded; retrying the affected quote (on its own or in a smaller batch) is safe
Fields
- Fields Included from *QuotesBatchUpdateResultBase
- id string
- status QuotesBatchUpdateResultStatus
- anydata...
- description string - Human-readable explanation of the internal error
- status? "internal_error" - Result status for this quote. Always
internal_error
pandadoc: QuotesBatchUpdateResultNotFound
Mirrors the single-quote endpoint's 404 response. This quote does not exist or has no resolvable current version
Fields
- Fields Included from *QuotesBatchUpdateResultBase
- id string
- status QuotesBatchUpdateResultStatus
- anydata...
- description string - Human-readable explanation of why the quote was not found
- status? "not_found" - Result status for this quote. Always
not_found
pandadoc: QuotesBatchUpdateResultNotInDocument
Mirrors the single-quote endpoint's 403 response. This quote is not part of the specified document's content
Fields
- Fields Included from *QuotesBatchUpdateResultBase
- id string
- status QuotesBatchUpdateResultStatus
- anydata...
- description string - Human-readable explanation of why the quote is not in the document
- status? "not_in_document" - Result status for this quote. Always
not_in_document
pandadoc: QuotesBatchUpdateResultOk
Per-quote success entry, mirroring the single-quote endpoint's 200 response. quote carries the same payload as that endpoint's body
Fields
- Fields Included from *QuotesBatchUpdateResultBase
- id string
- status QuotesBatchUpdateResultStatus
- anydata...
- quote QuoteResponse - The updated quote
- status? "ok" - Result status for this quote. Always
ok
pandadoc: QuotesBatchUpdateResultValidationError
Mirrors the single-quote endpoint's 400 response. The update payload for this quote failed validation (e.g. both price and price_settings set on the same item)
Fields
- Fields Included from *QuotesBatchUpdateResultBase
- id string
- status QuotesBatchUpdateResultStatus
- anydata...
- description string - Human-readable explanation of the validation failure
- status? "validation_error" - Result status for this quote. Always
validation_error
pandadoc: QuoteSectionSettings
Fields
- selectionType? "custom"|"single"|"multiple" -
- dataMergeEnabled? boolean -
- optional? boolean -
- selected? boolean -
pandadoc: QuoteUpdateRequest
Fields
- summary? QuoteUpdateRequestSummary - Summary settings containing adjustments (discounts, fees, taxes) and custom columns that apply to the entire quote / section total
- settings? QuoteUpdateRequestSelectionSettings - Quote settings. Denotes whether a quote is optional or selected, and selection type inside the section - single, multiple, or custom
- currency? string - Currency code (ISO 4217)
- sections? UpdateIntegrationQuoteSection[] - Quote sections - this property overrides existing sections in the specified order. If you want to change only one section, you must still pass other sections IDs. Otherwise these sections will be removed
pandadoc: QuoteUpdateRequestOptions
Denotes whether an item is selected, optional, and has editable quantity
Fields
- qtyEditable boolean(default true) - Whether the recipient can edit the item quantity
- optional boolean(default false) - Whether the item is optional for the recipient
- selected boolean(default true) - Whether the item is selected
pandadoc: QuoteUpdateRequestPriceSettings
Price settings if the price is not flat rate. If it is null, the price is flat rate
Fields
- tiers QuoteUpdateRequestPriceSettingsTiers[] - Price tiers for volume or tiered pricing
- baseValue decimal? - Base value for volume discount pricing. If set, tiers are treated like percentage of discount on this value. If not set, tiers are treated like a flat value discount of chosen currency
pandadoc: QuoteUpdateRequestPriceSettingsTiers
Fields
- minQty int -
- value decimal -
pandadoc: QuoteUpdateRequestSelectionSettings
Quote settings. Denotes whether a quote is optional or selected, and selection type inside the section - single, multiple, or custom
Fields
- selectionType? QuoteUpdateRequestSettingsSelectionTypeTypeEnum - How sections inside the quote can be selected: single, multiple or custom
pandadoc: QuoteUpdateRequestSettings
Section settings. Denotes whether a section is optional or selected, and selection type inside the section - single, multiple, or custom
Fields
- selectionType? QuoteUpdateRequestSettingsSelectionTypeTypeEnum - How items inside the section can be selected: single, multiple or custom
- optional? boolean - Whether the section is optional for the recipient
- selected? boolean - Whether the section is selected
pandadoc: QuoteUpdateRequestSummary
Summary settings containing adjustments (discounts, fees, taxes) and custom columns that apply to the entire quote / section total
Fields
- fees? record { QuoteUpdateRequestSummaryDiscounts... } - Summary level fees
- customColumns? record { string... } - Summary level custom column values, keyed by column name
- discounts? record { QuoteUpdateRequestSummaryDiscounts... } - Summary level discounts
- taxes? record { QuoteUpdateRequestSummaryDiscounts... } - Summary level taxes
pandadoc: QuoteUpdateRequestSummaryDiscounts
Fields
- 'type? QuoteUpdateRequestDiscountTypeEnum -
- value? decimal -
pandadoc: RadioButtons
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "radio_buttons" -
- value? string - Value of the Radio Buttons field
- mergeField? string -
pandadoc: RecipientAssignedTo
Recipient
Fields
- Fields Included from *RecipientAssignmentDetails
- deliveryMethods? AssignedToRecipientDeliveryMethods - Methods used to deliver the document to the recipient
- redirect? RecipientRedirectSettings - Redirect settings applied after the recipient completes the document
- role? string - Role assigned to the recipient
- phone? string - Phone number of the recipient
- lastName? string - Last name of the recipient
- 'type? "recipient" - Assignee type. Always
recipientfor an individual recipient
- firstName? string - First name of the recipient
pandadoc: RecipientAssignmentDetails
Fields
- recipientType? string -
- roles? string[] -
- signingOrder? int -
- id? string -
- email? string -
- hasCompleted? boolean -
pandadoc: RecipientDeliveryMethods
Fields
- sms? boolean -
- email? boolean -
pandadoc: RecipientPersonalDetails
Actor
Fields
- recipientType? RecipientTypeEnum - Type of the recipient
- role? string? - Role assigned to the recipient. Deprecated, use
rolesinstead
- roles? string[] - Roles assigned to the recipient
- signingOrder? int? - Position of the recipient in the signing order
- id? string - Unique identifier of the recipient
- email? string? - Email address of the recipient
- hasCompleted? boolean - Whether the recipient has completed the document
pandadoc: RecipientRedirect
Fields
- isEnabled boolean(default false) -
- url string? - A URL to redirect to after the document is signed
pandadoc: RecipientRedirectSettings
Fields
- isEnabled? boolean -
- url? string -
pandadoc: RecipientsGroupAssignedTo
Collection of Recipients
Fields
- Fields Included from *RecipientAssignmentDetails
- members? RecipientsGroupAssignedTo_members[] - Recipients in the group
- name? string - Name of the recipient group
- 'type? "recipient_group" - Assignee type. Always
recipient_groupfor a recipient group
pandadoc: RecipientsGroupAssignedTo_members
Fields
- lastName? string -
- id? string -
- firstName? string -
- email? string -
pandadoc: RecipientVerificationSettings
To set up recipient verification, provide verification_place (required) and exactly one verification type: passcode_verification, phone_verification, kba_verification, id_verification, or email_otp_verification. All other verification type fields must be null. Providing more than one verification type returns a 400 error.
- For passcode_verification, provide the passcode.
- For phone_verification, provide the phone_number.
- For email_otp_verification, provide the email.
- For kba_verification and id_verification, set the enabled parameter to true
Fields
- kbaVerification? RecipientVerificationSettingsKbaVerification? - Sets the KBA verification
- passcodeVerification? RecipientVerificationSettingsPasscodeVerification? - Sets the passcode
- emailOtpVerification? RecipientVerificationSettingsEmailOtpVerification? - Sets the email address to send a one-time passcode to
- idVerification? RecipientVerificationSettingsIdVerification? - Sets the ID verification
- verificationPlace? RecipientVerificationPlaceEnum - Point in the signing flow at which the recipient is verified
- phoneVerification? RecipientVerificationSettingsPhoneVerification? - Sets the phone number to send a passcode to
pandadoc: RecipientVerificationSettingsEmailOtpVerification
Sets the email address to send a one-time passcode to
Fields
- email string - An email address to send a one-time passcode to
pandadoc: RecipientVerificationSettingsIdVerification
Sets the ID verification
Fields
- enabled? boolean - Whether ID verification is enabled for the recipient
pandadoc: RecipientVerificationSettingsKbaVerification
Sets the KBA verification
Fields
- scoreThreshold? int - Minimum score required to pass the KBA verification
- timeLimitSec? int - Time limit to complete the KBA verification, in seconds
- maxAttemptsCount? int - Maximum number of KBA verification attempts allowed
pandadoc: RecipientVerificationSettingsPasscodeVerification
Sets the passcode
Fields
- passcode string - Document passcode
pandadoc: RecipientVerificationSettingsPhoneVerification
Sets the phone number to send a passcode to
Fields
- phoneNumber string - A phone number to send a passcode to
pandadoc: SearchCatalogItemsQueries
Represents the Queries record for the operation: searchCatalogItems
Fields
- perPage? decimal - Items per page
- types? ProductCatalogTypeEnum[] - Filter by catalog item types
- categoryId? string - Category id
- query? string - Search query. Searches the following fields: Title, SKU, description, category name, custom fields name and value
- noCategory? boolean - Return only items that are not assigned to any category
- orderBy? "sku"|"-sku"|"title"|"-title"|"price"|"-price"|"date_modified"|"-date_modified" - Ordering principle for displaying search results
- excludeUuids? string[] - A list of item uuids to be excluded from search
- page? decimal - Page number
- billingTypes? ("one_time"|"recurring")[] - Filter by billing types
pandadoc: SectionInfoResponse
Fields
- name? string -
- uuid? string -
- documentUuid? string -
pandadoc: Signature
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "signature" -
- value? record {} - Value of the Signature field. Always empty object
pandadoc: Stamp
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "stamp" -
- value? record {} - Value of the Stamp field. Always empty object
pandadoc: TableCell
Defines a single cell in the table, which can appear in either the header or the rows
Fields
- rowSpan? int? - Represents the number of rows the cell occupies
- text string - Cell text
- colSpan? int? - Represents how many columns the cell occupies
pandadoc: TableRequest
Fields
- data TableRequestData -
- name string - Name of the table
pandadoc: TableRequestData
Fields
- sections TableRequestDataSections[] -
pandadoc: TableRequestDataSections
Fields
- header TableCell[] -
- rows TableCell[][] -
pandadoc: TemplateCreateResponse
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- contentDateModified? string -
- id? string -
- version? string -
pandadoc: TemplateDetailsResponse
Fields
- metadata? record {} -
- images? TemplateDetailsResponseImages[] -
- dateCreated? string -
- roles? TemplateDetailsResponseRoles[] -
- contentDateModified? string -
- createdBy? TemplateDetailsResponseCreatedBy -
- version? string -
- tags? string[] -
- tables? DocumentDetailsResponseTables[] - Document tables
- dateModified? string -
- folderUuid? string -
- name? string -
- tokens? Token[] - Template tokens
- id? string -
- fields? Field[] - Template fields
- pricing? PricingResponse -
- contentPlaceholders? TemplateDetailsResponseContentPlaceholders[] -
pandadoc: TemplateDetailsResponseContentPlaceholders
Fields
- description? string -
- uuid? string -
- blockId? string -
pandadoc: TemplateDetailsResponseCreatedBy
Fields
- lastName? string -
- id? string -
- avatar? string? -
- firstName? string -
- email? string -
pandadoc: TemplateDetailsResponseImages
Fields
- blockUuid? string -
- urls? string[] -
- name? string? -
pandadoc: TemplateDetailsResponsePreassignedPerson
Fields
- members? TemplateDetailsResponsePreassignedPersonMembers[] - List of contacts in the group. Only present for type "preassigned contact group"
- placeholderSource? string? -
- lastName? string? -
- placeholderName? string? -
- 'type? string -
- firstName? string? -
- email? string? -
pandadoc: TemplateDetailsResponsePreassignedPersonMembers
Fields
- lastName? string? -
- firstName? string? -
- email? string? -
pandadoc: TemplateDetailsResponseRoles
Fields
- name? string -
- signingOrder? string? -
- id? string -
- preassignedPerson? TemplateDetailsResponsePreassignedPerson? -
pandadoc: TemplateDuplicateRequest
Request payload for duplicating a template within the same workspace
Fields
- name? string - Custom name for the duplicated template. When omitted or empty, a name is auto-generated from the source template
pandadoc: TemplateDuplicateResponse
Duplicated template details
Fields
- dateModified? string - Date and time when the duplicated template was last modified
- dateCreated? string - Date and time when the duplicated template was created
- meta? TemplateDuplicateResponseMeta - Metadata about the duplication operation
- name? string - Name of the duplicated template
- id? string - Unique identifier of the duplicated template
pandadoc: TemplateDuplicateResponseMeta
Metadata about the duplication operation
Fields
- sourceTemplateId? string - Unique identifier of the source template that was duplicated
pandadoc: TemplateEditingSessionResponse
Fields
- Fields Included from *BaseEditingSessionResponse
- templateId? string - ID of the template
pandadoc: TemplateListResponse
Fields
- results? TemplateCreateResponse[] -
pandadoc: TemplateRoleUpdateItemsInner
Fields
- name string - Role name. Must be unique within the template
- signingOrder? int? - Signing order for the role. Set on every role as a contiguous sequence starting from
1(duplicates allowed for parallel groups, e.g.[1, 1, 2]), or usenullon every role for fully parallel signing
- id? string - Existing role identifier. Omit to create a new role
pandadoc: TemplateSettingsResponse
Template settings response
Fields
- language DocumentLanguageEnum - Document language code (e.g., 'en-US', 'fr-FR')
pandadoc: TemplatesFolderCreateRequest
Fields
- parentUuid? string - ID of the parent folder. To create a new folder in the root folder, remove this parameter in the request
- name string - Name the folder for Templates you are creating
pandadoc: TemplatesFolderCreateResponse
Fields
- dateCreated? string -
- name? string -
- uuid? string -
pandadoc: TemplatesFolderListResponse
Fields
- results? TemplatesFolderListResponseResults[] -
pandadoc: TemplatesFolderListResponseResults
Fields
- hasFolders? boolean -
- dateCreated? string -
- name? string -
- uuid? string -
- hasItems? boolean -
pandadoc: TemplatesFolderRenameRequest
Fields
- name string - Provide a new name for the folder
pandadoc: TemplatesFolderRenameResponse
Fields
- dateCreated? string -
- name? string -
- uuid? string -
pandadoc: TemplateSharesRequest
The desired set of Workspaces a Template should be shared with
Fields
- workspaceIds string[] - Unique identifiers of the Workspaces the Template should be shared with, representing the complete desired end-state rather than a delta. Duplicate ids are deduplicated, and the server replaces the prior shares with this set atomically
pandadoc: TemplateSharesResponse
The Workspaces a Template is currently shared with
Fields
- workspaceIds string[] - Unique identifiers of the Workspaces the Template is currently shared with, reflecting the server state at the time of the response
pandadoc: TemplateStatusResponse
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- id? string -
- version? string -
- status? "template.PROCESSED"|"template.UPLOADED"|"template.ERROR" -
pandadoc: TemplateUpdateRequest
Fields
- roles? TemplateRoleUpdateItems - Replace the full set of template roles. Items with an existing
idare updated, items without anidare created as new roles, and existing roles whoseidis not present in the list are deleted
- tokens? Tokens - Create or initialize multiple CUSTOM variables with their values using tokens/values list. Template's predefined variables are read-only. Any attempts to do so will be ignored
pandadoc: Text
Fields
- Fields Included from *BaseField
- fieldId string
- isFilled boolean
- name string
- placeholder string
- title string
- type FieldTypeEnum
- uuid string
- assignedTo RecipientAssignedTo|RecipientsGroupAssignedTo
- anydata...
- 'type? "text" -
- value? string - Value of the Text field
- mergeField? string? -
pandadoc: Token
Fields
- name string - Token name
- value? string - Token value
pandadoc: UpdateDocumentAutoRemindersRequest
Fields
- initialDelayDays? int - Number of days to wait after sending the document before the first reminder is sent
- recurrenceFrequencyDays? int - Number of days between recurring reminders, applicable if
is_recurringistrue
- deliveryMethod? DocumentDeliveryMethodEnum -
- enabled boolean - Toggles auto-reminders for the document.
If
true, reminders are scheduled based on the configuration
- isRecurring? boolean - If
true, reminders will be sent repeatedly at specified intervals after the initial reminder
pandadoc: UpdateDocumentAutoRemindersResponse
Fields
- initialDelayDays? int - Number of days to wait after sending the document before the first reminder is sent
- recurrenceFrequencyDays? int - Number of days between recurring reminders, applicable if
is_recurringistrue
- deliveryMethod? DocumentDeliveryMethodEnum -
- enabled boolean - Toggles auto-reminders for the document.
If
true, reminders are scheduled based on the configuration
- isRecurring? boolean - If
true, reminders will be sent repeatedly at specified intervals after the initial reminder
pandadoc: UpdateDocumentFieldsAssignmentRequest
Request body for updating field assignments on a document
Fields
- fields DocumentFieldAssignmentItem[] - An array of field assignment operations. Each item specifies a field and the recipient it should be assigned to
pandadoc: UpdateDocumentRecipient
Fields
- Fields Included from *BaseIdentity
- deliveryMethods? RecipientDeliveryMethods? -
- redirect? RecipientRedirect -
- signingOrder? int? - Set a signing order for a recipient. Pass
nullfor all recipients to disable the signing order. Learn more: https://developers.pandadoc.com/docs/set-signing-order
- id? string -
- 'type? "recipient" -
pandadoc: UpdateDocumentRecipientGroup
Fields
- members? BaseIdentity[] -
- name string -
- signingOrder? int? - Set a signing order for a recipient group. Pass
nullfor all recipients to disable the signing order. Learn more: https://developers.pandadoc.com/docs/set-signing-order
- id? string -
- 'type? "recipient_group" -
pandadoc: UpdateDocumentSettingsRequest
Document settings update request
Fields
- language? DocumentLanguageEnum - Document language code (e.g., 'en-US', 'fr-FR')
- qualifiedElectronicSignature? boolean - Indicates whether the document requires a Qualified Electronic Signature (QES)
during the signing process. If
true, signers must complete the document using a third-party qualified electronic signature provider according to supported verification rules
- expiresIn? Signed32 - Document expiration in days. Minimum is 1 day
- suggestEdits? boolean - Enables or disables Suggest Edits (redlining) for the document. When
true, recipients can suggest edits to the document content. Can only be changed while the document is indraftstatus
pandadoc: UpdateIntegrationQuoteSection
Fields
- summary? QuoteUpdateRequestSummary - Summary settings containing adjustments (discounts, fees, taxes) and custom columns that apply to the entire quote / section total
- settings? QuoteUpdateRequestSettings - Section settings. Denotes whether a section is optional or selected, and selection type inside the section - single, multiple, or custom
- name string?(default "Section name") - Name of the quotes section. If you create a section without providing a value, it will have the default value
- id? string - Section ID to update. Invalid (or missing) ID causes creating a new section
- items? UpdateIntegrationQuoteSectionItem[] - Section items - this property overrides the existing items in the order specified. If you want to change only one item, you must still pass other items IDs. Otherwise these items will be removed
pandadoc: UpdateIntegrationQuoteSectionItem
Fields
- fees? record { QuoteUpdateRequestSummaryDiscounts... } - Item fees
- cost? decimal - Item cost. If you create an item without providing a value, it will have the default value
- referenceId? string? - Use this field to pass an id that references this item in external systems
- description string(default "") - Item description. If you create an item without providing a value, it will have the default value
- priceSettings? QuoteUpdateRequestPriceSettings -
- taxes? record { QuoteUpdateRequestSummaryDiscounts... } - Item taxes
- contractTerm? int? - Contract term. Measured in units set in the
billing_frequencyparameter
- billingFrequency? QuoteUpdateRequestBillingFrequencyEnum? -
- customColumns? record { string... } -
- discounts? record { QuoteUpdateRequestSummaryDiscounts... } - Item discounts
- price decimal(default 0) - Item price. If you create an item without providing a value, it will have the default value. If
price_settingsis passed, this value may change after the quote is updated
- qty int(default 1) - Item QTY. If you create an item without providing a value, it will have the default value
- name string(default "") - Item name. If you create an item without providing a value, it will have the default value
- options? QuoteUpdateRequestOptions - Denotes whether an item is selected, optional, and has editable quantity
- multipliers? record {||} - Item multipliers
- id? string - Item ID to update. Invalid (or missing) ID causes creating a new item
- sku string(default "#") - Product SKU. If you create an item without providing a value, it will have the default value
- externalColumns? record { string... } -
- textColumns? record { string... } -
pandadoc: UpdateMemberRoleRequest
Fields
- role WorkspaceMemberRoleEnum - Role for a member
pandadoc: UpdateMemberRoleResponse
Fields
- memberId? string -
- workspaceId? string -
- role? WorkspaceMemberRoleEnum - Role for a member
- email? string -
pandadoc: UpdatePrivacySettings
Fields that can be changed on a workspace privacy settings PATCH. Omit any field you want to leave unchanged
Fields
- aiFeaturesEnabled? boolean - Master switch for AI features. Setting it to
falsealso disablesai_on_premises_processing_enabled,ai_cloud_third_party_enabled,ai_on_premises_training_enabled, andai_third_party_training_enabled
- aiThirdPartyTrainingEnabled? boolean - Whether third-party model training is enabled
- aiOnPremisesProcessingEnabled? boolean - Whether PandaDoc-operated AI processing is enabled
- aiCloudThirdPartyEnabled? boolean - Whether third-party cloud AI processing is enabled
pandadoc: UpdateTemplateSettingsRequest
Template settings update request
Fields
- language? DocumentLanguageEnum - Document language code (e.g., 'en-US', 'fr-FR')
pandadoc: UpdateWorkspaceRequest
Request payload to update a workspace. All fields are optional — omit a field to
keep its current value. Nullable fields accept null to clear the current value
Fields
- iconUrl? string? - Workspace icon displayed in the application; not visible to your customers. Icon should have square proportions. The URL must be publicly reachable over HTTPS. Supported formats: JPEG, PNG, GIF, WEBP. Max size: 5 MB
- branding? WorkspaceBranding - Customer-facing branding shown to recipients on the document signing page and in branded emails and templates
- name? string - A new name for the workspace
pandadoc: UpdateWorkspaceResponse
Workspace state returned after a successful update
Fields
- branding? WorkspaceBranding - Customer-facing branding shown to recipients on the document signing page and in branded emails and templates
- name? string - Current workspace name
- id? string - Workspace id
pandadoc: UploadSectionBase
Fields
- recipients CreateDocumentActor[] - The list of recipients you're sending the document to. Every object must contain the
emailparameter. Therole,first_nameandlast_nameparameters are optional. If theroleparameter is passed, a person is assigned all fields matching their corresponding role. If a role was not passed, a person receives a read-only link to view the document. If thefirst_nameandlast_nameare not passed, the system does this 1. Creates a new contact, if none exists with the givenemail; or 2. Gets the existing contact with the givenemailthat already exists
- name? string - Name the document you are creating
- tokens? DocumentUpdateRequestTokens[] - You may pass a list of tokens/values to pre-fill tokens (variables) used in a template. Name is a token (variable) name in a template. Value is a real value you would like to replace a token (variable) with
- tags? string[] - Mark your document with one or several tags
pandadoc: UploadSectionByFileRequest
Fields
- Fields Included from *UploadSectionRequest
- parseFormFields boolean
- fields record { anydata... }
- parseTextTags boolean
- recipients CreateDocumentActor[]
- name string
- tokens DocumentUpdateRequestTokens[]
- tags string[]
- anydata...
- url string - Secure (HTTPS) and publicly accessible URL to the PDF document
pandadoc: UploadSectionByTemplateRequest
Fields
- templateUuid string - The ID of a template you want to use. You can copy it from an in app template url such as
https://app.pandadoc.com/a/#/templates/{ID}/content. A template ID is also obtained by listing templates
- pricingTables? PricingTableRequest[] - Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. Make sure that "Automatically add products to this table" is enabled in the PandaDoc template pricing tables you wish to populate via API. Each pricing table must have a unique name to populate it with data correctly
- fields? record {} - You can pass a list of fields/values to pre-fill fields used in a template. Note that the Signature field can't be pre-filled. Field values with the same merge id will override field values of the whole document by default, unless you set the merge_field_scope=upload query parameter
- contentPlaceholders? UploadSectionByTemplateRequest_content_placeholders[] - You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there
- Fields Included from *UploadSectionBase
- recipients CreateDocumentActor[]
- name string
- tokens DocumentUpdateRequestTokens[]
- tags string[]
- anydata...
pandadoc: UploadSectionByTemplateRequest_content_library_items
Fields
- recipients? UploadSectionByTemplateRequest_recipients[] -
- pricingTables? PricingTableRequest[] -
- id string -
- fields? record {} -
pandadoc: UploadSectionByTemplateRequest_content_placeholders
Fields
- contentLibraryItems? UploadSectionByTemplateRequest_content_library_items[] -
- blockId string -
pandadoc: UploadSectionByTemplateRequest_recipients
Fields
- deliveryMethods? RecipientDeliveryMethods? -
- redirect? RecipientRedirect -
- role? string -
- phone? string? -
- lastName? string -
- signingOrder? int? -
- firstName? string -
- email? string? -
pandadoc: UploadSectionFromFileQueries
Represents the Queries record for the operation: uploadSectionFromFile
Fields
- mergeFieldScope? "document"|"upload" - Determines how the fields are mapped when creating a section.
- document: Default value. The fields of the entire document are updated.
- upload: Only the fields from the created section are updated. The merge field is appended with the upload ID
pandadoc: UploadSectionListResponse
Fields
- results? UploadSectionListResponseResults[] -
pandadoc: UploadSectionListResponseResults
Fields
- name? string -
- uuid? string -
pandadoc: UploadSectionQueries
Represents the Queries record for the operation: uploadSection
Fields
- mergeFieldScope? "document"|"upload" - Determines how the fields are mapped when creating a section.
- document: Default value. The fields of the entire document are updated.
- upload: Only the fields from the created section are updated. The merge field is appended with the upload ID
pandadoc: UploadSectionRequest
Fields
- parseFormFields? boolean - Set this parameter as
trueif you create a document from a PDF with form fields and asfalseif you upload a PDF with field tags
- fields? record {} - If you are upload a section from a PDF with field tags, you can pass a list of the fields you'd like to pre-fill in the document. If you are upload a section from a PDF with form fields, list all the fields and provide the
roleparameter so that the fields are assigned to document recipients. You can provide empty value for the field so that it's not pre-filled: "value": "". Please note Signature field can't be pre-filled
- parseTextTags boolean(default true) - Set this parameter as
falseto skip detection and validation of field tags in the uploaded file, keeping them as regular text
- recipients CreateDocumentActor[] - The list of recipients you're sending the document to. Every object must contain the
emailparameter. Therole,first_nameandlast_nameparameters are optional. If theroleparameter is passed, a person is assigned all fields matching their corresponding role. If a role was not passed, a person receives a read-only link to view the document. If thefirst_nameandlast_nameare not passed, the system does this 1. Creates a new contact, if none exists with the givenemail; or 2. Gets the existing contact with the givenemailthat already exists
- Fields Included from *UploadSectionBase
- recipients CreateDocumentActor[]
- name string
- tokens DocumentUpdateRequestTokens[]
- tags string[]
- anydata...
pandadoc: UploadSectionResponse
Fields
- dateModified? string -
- dateCreated? string -
- name? string -
- dateCompleted? string? -
- uuid? string -
- documentUuid? string -
- infoMessage? string -
- status? UploadSectionStatusEnum -
pandadoc: UploadSectionStatusResponse
Fields
- sectionsUuids? string[] -
- dateModified? string -
- dateCreated? string -
- name? string -
- uuid? string -
- documentUuid? string -
- status? UploadSectionStatusEnum -
pandadoc: UploadSectionWithUploadRequest
Fields
- file? record { fileContent byte[], fileName string } - Binary PDF/DocX/RTF File
- data? UploadSectionRequest -
pandadoc: WebhookEventDetailsResponse
Fields
- responseHeaders? string? - Webhook subscription response headers
- requestBody? string - Webhook subscription event request body
- httpStatusCode? Signed32? - Webhook subscription event response http status code
- signature? string - Webhook subscription event digital signature
- name? string - Webhook subscription name
- responseBody? string? - Webhook subscription response body
- deliveryTime? string - Webhook subscription event delivery time
- 'type? WebhookEventTriggerEnum -
- 'error? WebhookEventErrorEnum? -
- uuid? string? - Unique webhook subscription event identifier
- url? string - Webhook subscription event destination url
- eventTime? string - Webhook subscription event trigger time
pandadoc: WebhookEventItemResponse
Fields
- httpStatusCode? Signed32? - Webhook subscription event response http status code
- name? string - Webhook subscription name
- deliveryTime? string - Webhook subscription event delivery time
- 'type? WebhookEventTriggerEnum -
- 'error? WebhookEventErrorEnum? -
- uuid? string? - Unique webhook subscription event identifier
pandadoc: WebhookEventPageResponse
Fields
- items? WebhookEventItemResponse[] -
pandadoc: WebhookSubscriptionCreateRequest
Fields
- payload? WebhookSubscriptionPayloadEnum[]? - Set a payload structure
- name string - Set a name for the Webhooks subscription
- active boolean(default true) - Set the status of the Webhooks subscription
- triggers WebhookSubscriptionTriggerEnum[]? - Set trigger events for the Webhooks subscription
- url string - Set the Webhooks subscription URL
pandadoc: WebhookSubscriptionItemResponse
Fields
- workspaceId? string -
- payload? WebhookSubscriptionPayloadEnum[]? -
- name? string -
- active? boolean -
- triggers? WebhookSubscriptionTriggerEnum[]? -
- uuid? string? -
- url? string -
- sharedKey? string -
- status? WebhookSubscriptionStatusEnum -
pandadoc: WebhookSubscriptionListResponse
Fields
- items? WebhookSubscriptionItemResponse[] -
pandadoc: WebhookSubscriptionPatchRequest
Fields
- payload? WebhookSubscriptionPayloadEnum[]? - Set a new payload structure
- name? string - Set a new name for the Webhooks subscription
- active boolean(default true) - Set the status of the Webhooks subscription
- triggers? WebhookSubscriptionTriggerEnum[]? - Set trigger events for the Webhooks subscription
- url? string - Set the new Webhooks subscription URL
pandadoc: WebhookSubscriptionSharedKeyResponse
Fields
- sharedKey? string -
pandadoc: WorkspaceBranding
Customer-facing branding shown to recipients on the document signing page and in branded emails and templates
Fields
- accentColor? string? - Accent color as a 6-digit HEX value (with leading
#). Sets the main branded template color and email button color
- logoUrl? string? - Logo shown to recipients. The URL must be publicly reachable over HTTPS. Supported formats: JPEG, PNG, GIF, WEBP. Max size: 5 MB
Union types
pandadoc: WebhookSubscriptionPayloadEnum
WebhookSubscriptionPayloadEnum
pandadoc: DocumentDeliveryMethodEnum
DocumentDeliveryMethodEnum
The method used to deliver reminders (e.g., email, SMS)
pandadoc: WebhookSubscriptionStatusEnum
WebhookSubscriptionStatusEnum
pandadoc: QuoteUpdateRequestSettingsSelectionTypeTypeEnum
QuoteUpdateRequestSettingsSelectionTypeTypeEnum
pandadoc: DocumentDetailsResponseRecipients
DocumentDetailsResponseRecipients
pandadoc: WebhookEventHttpStatusCodeGroupEnum
WebhookEventHttpStatusCodeGroupEnum
pandadoc: WebhookEventTriggerEnum
WebhookEventTriggerEnum
pandadoc: Field
Field
pandadoc: ApiLogEnvironmentTypeEnum
ApiLogEnvironmentTypeEnum
pandadoc: QuoteUpdateRequestDiscountTypeEnum
QuoteUpdateRequestDiscountTypeEnum
pandadoc: ProductCatalogTypeEnum
ProductCatalogTypeEnum
pandadoc: FieldTypeEnum
FieldTypeEnum
pandadoc: DocumentCreateRequest
DocumentCreateRequest
pandadoc: DocumentQESStatusEnum
DocumentQESStatusEnum
The status of the QES (Qualified Electronic Signature) for the document. It indicates whether the QES process is still pending or has been completed
pandadoc: CreateDocumentActor
CreateDocumentActor
pandadoc: ApiLogStatusEnum
ApiLogStatusEnum
pandadoc: DocumentDocxExportStatusEnum
DocumentDocxExportStatusEnum
| Status | Description |
|---|---|
| created | The export task has been created, but the process has not started. |
| processing | The export task is in progress. |
| done | The export task is completed, and the response contains URLs for downloading the documents. |
| error | An error occurred during the execution of the export task. |
pandadoc: RecipientTypeEnum
RecipientTypeEnum
pandadoc: WebhookSubscriptionTriggerEnum
WebhookSubscriptionTriggerEnum
pandadoc: RecipientKindEnum
RecipientKindEnum
pandadoc: AccessTokenRequest
AccessTokenRequest
pandadoc: WorkspaceMemberRoleEnum
WorkspaceMemberRoleEnum
Role for a member
pandadoc: DocumentStatusEnum
DocumentStatusEnum
pandadoc: EditDocumentRecipientBody
EditDocumentRecipientBody
pandadoc: UploadSectionStatusEnum
UploadSectionStatusEnum
pandadoc: DocumentFieldAnchorPointEnum
DocumentFieldAnchorPointEnum
pandadoc: UploadSectionRequestBody
UploadSectionRequestBody
pandadoc: DocumentOrderingFieldsEnum
DocumentOrderingFieldsEnum
pandadoc: ApiLogMethodEnum
ApiLogMethodEnum
pandadoc: DocumentStatusChangeRequestStatusEnum
DocumentStatusChangeRequestStatusEnum
Number code for the target document status. See notes for the codes corresponding to each status
pandadoc: ApiKeyTypeEnum
ApiKeyTypeEnum
A type of API key
pandadoc: DocumentLanguageEnum
DocumentLanguageEnum
Document language code (e.g., 'en-US', 'fr-FR')
pandadoc: QuotesBatchUpdateResult
QuotesBatchUpdateResult
Outcome for a single quote in a batch update request. The concrete shape is selected by the status discriminator
pandadoc: WebhookEventErrorEnum
WebhookEventErrorEnum
pandadoc: UpdateDocumentActor
UpdateDocumentActor
pandadoc: DocumentStatusRequestEnum
DocumentStatusRequestEnum
pandadoc: UserLicenseEnum
UserLicenseEnum
pandadoc: RecipientVerificationPlaceEnum
RecipientVerificationPlaceEnum
Specifies when a recipient must complete the verification process:
before_open(before opening the document),before_sign(before signing the document)
pandadoc: QuoteUpdateRequestBillingFrequencyEnum
QuoteUpdateRequestBillingFrequencyEnum
pandadoc: ProductCatalogPricingMethodEnum
ProductCatalogPricingMethodEnum
pandadoc: QuotesBatchUpdateResultStatus
QuotesBatchUpdateResultStatus
Per-quote outcome discriminator. ok, validation_error, not_in_document, not_found, and conflict mirror the single-quote update endpoint's 200/400/403/404/409 responses respectively — see each variant's own schema. internal_error is exclusive to the batch endpoint and indicates an isolated server-side failure for that quote only; the request as a whole succeeded and other quotes in the same batch are unaffected
Array types
pandadoc: Tokens
Tokens
Create or initialize multiple CUSTOM variables with their values using tokens/values list. Template's predefined variables are read-only. Any attempts to do so will be ignored
pandadoc: ListDocumentsByLinkedObjectsResponse
ListDocumentsByLinkedObjectsResponse
pandadoc: BulkDeleteDocumentsRequest
BulkDeleteDocumentsRequest
List of documents to delete. Each object must contain a document id
pandadoc: TemplateRoleUpdateItems
TemplateRoleUpdateItems
Replace the full set of template roles. Items with an existing id are updated, items without an id are created as new roles, and existing roles whose id is not present in the list are deleted
String types
pandadoc: ListNotariesQueriesCommissionstateItemsString
ListNotariesQueriesCommissionstateItemsString
Simple name reference types
pandadoc: RecipientVerificationSettingsResponse
RecipientVerificationSettingsResponse
Recipient verification settings as returned in document details.
null when verification is not configured for the recipient
Import
import ballerinax/pandadoc;Metadata
Released date: about 19 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 49
Current verison: 1
Weekly downloads
Keywords
Vendor/PandaDoc
Area/Productivity & Collaboration
Type/Connector
Contributors