PandaDoc tools
The 12 PandaDoc operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List documentsGETLists the documents of the workspace with id, name, status and dates, 50 per page by default. Ask for the next page with page; a page with fewer results than count is the last one.
- Get documentGETReturns the details of a document: status, recipients with their id, has_completed and shared_link, fields, tokens, pricing, texts, metadata and tags. Works once the document has left the document.uploaded status.
- Get document statusGETReturns the id, name and status of a document. After Create document the status stays document.uploaded for a few seconds; wait for document.draft before updating or sending it.
- Create documentPOSTCreates a document from a template (template_uuid) or from a public PDF (url and name). It stays document.uploaded for a few seconds and then turns document.draft. Nothing is sent: call Send document once Get document status shows document.draft.
- Update documentPATCHUpdates a document in the document.draft status: name, recipients, variables, fields, text blocks, pricing tables, metadata and tags. For a document already sent, call Move document to draft first.
- Move document to draftPOSTMoves a sent or completed document back to document.draft so Update document can change it. Signature and initials fields are cleared, recipients are not told, and the document must be sent again.
- Send documentPOSTSends a document in the document.draft status to its recipients, by email unless silent is true, and moves it to document.sent, which locks its structure. With a sandbox key, recipients must share the sender's email domain.
- Send document reminderPOSTSends a reminder now to recipients who still have to complete a sent document. The result says, per recipient, whether each reminder went out; with a signing order, only the current signer can be reminded.
- Delete documentDELETEDeletes a document. With forever false it goes to the Trash Bin, where it can be restored; without forever, PandaDoc deletes it permanently.
- List templatesGETLists the templates of the workspace with id and name, a page at a time. A page with fewer results than count is the last one.
- Get templateGETReturns the details of a template: roles, fields, tokens (variables), pricing tables, texts, content placeholders, metadata and tags, which tell what Create document can fill.
- List document foldersGETLists the document folders inside a folder, with uuid and name. Without parent_uuid it lists the folders at the root, which is not listed itself.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
