Skip to main content
New to Corsair? See API access, authentication, and error handling.

Contacts

create

contacts.create Create a contact Risk: write
Input Output

delete

contacts.delete Delete a contact Risk: destructive · Irreversible
Input Answers 204 with no body. Output

get

contacts.get Read one contact by id Risk: read
Input Output

list

contacts.list List contacts, optionally filtered by exact email address Risk: read
Input The email filter matches the exact address. Output

update

contacts.update Update a contact Risk: write
Input The API does not change the email of an existing contact. Output

Documents

create

documents.create Create a draft document from a template or from a public PDF URL Risk: write
Input Two creation bodies: from a template (template_uuid plus recipients) or from a public HTTPS PDF (url plus name). The answer is 201 with the document in document.create_pending while it renders.
Output

createFields

documents.createFields Place new fields on a document Risk: write
Input
Output

delete

documents.delete Delete a document, optionally permanently (forever) Risk: destructive · Irreversible
Input Answers 204 with no body. With forever: true the document is deleted permanently instead of moved to deleted documents. Output

download

documents.download Download a document as PDF, with optional watermarking Risk: read
Input Answers a PDF; while the document is still rendering the API answers 202 and the operation reports pending: true instead of an empty file. Output

downloadProtected

documents.downloadProtected Download a completed document as a protected (flattened) PDF; needs a production key (sandbox keys get 401) Risk: read
Input Answers the flattened PDF of a completed document; 202 while it renders, reported as pending: true. Output

get

documents.get Read one document with its recipients, status and metadata Risk: read
Input Output

list

documents.list List documents, filtered by status, folder, contact, dates or metadata Risk: read
Input Status filters are numeric codes (0 = document.draft, 1 = document.sent, 2 = document.completed, 3 = document.uploaded, 4 = document.error, 5 = document.viewed, 6 = document.waiting_approval). Metadata filters take the documented metadata_key=value format, one array entry per filter. Output

listFields

documents.listFields Read the fields placed on a document with their coordinates Risk: read
Input Output

move

documents.move Move a document into a folder Risk: write
Input Answers 204 with no body. Output

send

documents.send Send a document to its recipients for signing; the signing emails cannot be recalled (silent: true sends without emails) Risk: destructive · Irreversible
Input Sends the document to its recipients by email (silent: true sends without emails or reminders; approval notifications still go out). This cannot be recalled.
Output

update

documents.update Update a draft document: name, recipients, fields, tokens, metadata or tags Risk: write
Input
Output

Folders

create

folders.create Create a documents folder Risk: write
Input Answer carries the folder uuid used to place documents and parents. Output

list

folders.list List document folders, optionally under one parent folder Risk: read
Input Output

rename

folders.rename Rename a documents folder Risk: write
Input Answers 204-level success as a folder object; pass the uuid, not the name. Output

Templates

delete

templates.delete Delete a template Risk: destructive · Irreversible
Input Answers 204 with no body. Output

get

templates.get Read one template with its fields, tokens and roles Risk: read
Input Output

list

templates.list List templates, filtered by name, folder, tag or shared state Risk: read
Input Output

Webhooks

createSubscription

webhooks.createSubscription Create a webhook subscription for the events you choose Risk: write
Input The answer carries the subscription’s shared_key: store it (keys.set_webhook_signature) so deliveries can be verified. Output

deleteSubscription

webhooks.deleteSubscription Delete a webhook subscription; deliveries stop until it is created again Risk: destructive · Irreversible
Input Answers 204 with no body. Output

getEvent

webhooks.getEvent Read one webhook event by the id a delivery carries Risk: read
Input The id comes from the X-PandaDoc-Webhook-Event-Id header of a delivery. Output

listSubscriptions

webhooks.listSubscriptions List the workspace webhook subscriptions, including their shared keys Risk: read
Input: empty object Output