Get zapier document

GET/api/v1/zapierDocument

Hydrate a document for Zapier or retrieve a summary

Returns an array containing zero or one document. Without detail_level, this is the document-status webhook hydration surface and needs webhooks:document_status. Supplying summary or full switches authorization to documents:read. Provide document_id for a specific document or status for the most recent matching document.

Permission

An OAuth access token with any one of these scopes. How to get a token

webhooks:document_status
Subscribe to document status changes.
documents:read
Read document summaries and hydrated document data.

detail_level_absent needs webhooks:document_status.

detail_level_present needs documents:read.

Parameters

Not sure what to enter? Here’s where to find IDs.

client_idquery · stringrequired
The Client ID of your OAuth client. It’s public, and goes on every request alongside your access token. Find it in QuoteCloud under Settings → API dashboard → Manage Integrations → OAuth Clients.Length at least 1.
document_idquery · string
The document’s number, shown as #1234 in the ID column of your documents list and beside the title in the editor. Enter it without the #. Leave this out to use status instead.
statusquery · string
Returns the most recent document with this status. Used when document_id is left out.One of sent, opened, signing, signing_complete, part_paid, paid, accepted, lost, canceled, creating, revising, workflow_review_requested, workflow_review_accepted, pending_sent, scheduled_send, delivery_delayed, delivered, alert, email_complained, email_bounced, send_failed, expired, custom, template, system_template.
detail_levelquery · string
How much of the document to return. Leave this out for the status webhook payload.One of summary, full.
x-quotecloud-zapier-versionheader · string
Sent by the QuoteCloud Zapier integration. You can leave this out.

Responses

200Zero or one hydrated document.

An array. Each item has:

Exactly one of these:

ZapierDocument
idstring
documentIdstringrequired
documentRefstring
displayIdinteger
titlestringrequired
subtitlestring
statusNamestringrequired
internalLinksobjectrequired
Fields
viewstring (uri)required
editstring (uri)required
pdfLinkstring (uri)required
pdfFilestring (uri)
recipientsarray of objectrequired
Item fields
idstringrequired
recipientRefstringrequired
firstNamestringrequired
lastNamestringrequired
fullNamestringrequired
emailstringrequired
viewLinkstring (uri)
phonestring
mobilestring
jobTitlestring
addressstring
companystring
accountRefstring
positionstring
One of primary, toRecipient, ccRecipient, bccRecipient.
ownerobjectrequired
Fields
namestringrequired
lastNamestringrequired
fullNamestringrequired
emailstringrequired
phonestring
jobTitlestring
microsoftUsernamestring
slackUsernamestring
whatsappUsernamestring
addressstring
companyobjectrequired
Fields
namestringrequired
phonestringrequired
countrystringrequired
address1stringrequired
address2stringrequired
citystringrequired
statestringrequired
postcodestringrequired
costsobjectrequired
Fields
currencystringrequired
currencySymbolstringrequired
totalMinCostnumberrequired
totalIncTaxnumberrequired
totalExcludedTaxnumberrequired
totalDiscountnumberrequired
totalTaxnumberrequired
totalMarkupnumberrequired
totalMarginnumberrequired
oneOffCostnumberrequired
oneOffTaxnumberrequired
oneOffTotalnumberrequired
fullTermCostnumberrequired
fullTermTaxnumberrequired
fullTermTotalnumberrequired
lineItemsarray of objectrequired
Item fields
tableIndexintegerrequired
tableNamestringrequired
currencystringrequired
currencySymbolstringrequired
productIdnumber
namestringrequired
descriptionstringrequired
skustring
pricenumberrequired
quantitynumberrequired
termnumber
termLabelstring
discountnumberrequired
discountPercentagenumber
additionsnumberrequired
additionsPercentagenumber
taxAmountnumberrequired
taxAmountCalculatednumber
taxPercentagenumber
totalExTaxnumberrequired
totalnumberrequired
isOneOffbooleanrequired
isSelectedbooleanrequired
isHiddenbooleanrequired
isExcludedFromTotalbooleanrequired
customColumnsobject
pricingTableSummariesarray of objectrequired
Item fields
tableIndexintegerrequired
tableNamestringrequired
currencystringrequired
currencySymbolstringrequired
totalExTaxnumberrequired
totalTaxnumberrequired
totalDiscountnumberrequired
totalIncTaxnumberrequired
signaturesarray of objectrequired
Item fields
emailstringrequired
recipientIdstringrequired
signerFirstNamestring
signerLastNamestring
signatureTypestring
One of draw, type, upload.
signedAtstring (date-time)
ipAddressstring
isSignedbooleanrequired
formSubmissionsarray of objectrequired
Item fields
formFieldsobjectrequired
sentDatestring (date-time)
statusChangedAtstring (date-time)
acceptedDatestring (date-time)
expiredDatestring (date-time)
coolingOffDatestring (date-time)
forcastDatestring (date-time)
numberOfViewsnumberrequired
forcaseConfidencenumberrequired
forcastEstimatedValuenumberrequired
customFieldsobject
statusstringrequired
pricingTablesarray of objectrequired
Item fields
dataobjectrequired
totalValuesobject
formsarray of object
Item fields
formDataJsonany
formSubmissionJsonobject
esignarray of objectrequired
Item fields
emailstringrequired
recipientIdstringrequired
signedDataobject
ZapierDocumentSummary
idstringrequired
documentRefstringrequired
displayIdintegerrequired
titlestringrequired
subtitlestringrequired
statusstringrequired
statusNamestringrequired
sourcestringrequired
ownerobjectrequired
Fields
namestringrequired
lastNamestringrequired
fullNamestringrequired
emailstringrequired
phonestring
jobTitlestring
microsoftUsernamestring
slackUsernamestring
whatsappUsernamestring
addressstring
createdDatestring (date-time)required
statusChangedAtstring (date-time)
modifiedDatestring (date-time)required
401Missing or invalid bearer token or client ID.
errorstringrequired
error_descriptionstring
403Insufficient scope, missing add-on, usage limit, or permission denial.

Exactly one of these:

OAuthError
errorstringrequired
error_descriptionstring
ApiErrorEnvelope
dataobjectrequired
Fields
statusstringrequired
Always error.
messagestringrequired
codestring
documentRefstring
assetGenerationIdstring
errorsarray of object
Item fields
fieldstringrequired
messagestringrequired
404Requested resource was not found in the token's company.
dataobjectrequired
Fields
statusstringrequired
Always error.
messagestringrequired
codestring
documentRefstring
assetGenerationIdstring
errorsarray of object
Item fields
fieldstringrequired
messagestringrequired
413The document is too large for full webhook hydration.
dataobjectrequired
Fields
statusstringrequired
Always error.
messagestringrequired
codestring
documentRefstring
assetGenerationIdstring
errorsarray of object
Item fields
fieldstringrequired
messagestringrequired
429Shared company API request quota exceeded. Wait before retrying.
Retry-Afterheader · integer
Minimum seconds to wait before retrying.Value at least 1.
dataobjectrequired
Fields
statusstringrequired
Always error.
messagestringrequired
retryAfterSecondsintegerrequired
Value at least 1.
500Unexpected server error.
dataobjectrequired
Fields
statusstringrequired
Always error.
messagestringrequired
codestring
documentRefstring
assetGenerationIdstring
errorsarray of object
Item fields
fieldstringrequired
messagestringrequired

Rate limit

120 requests a minute per company, shared across REST, Zapier and MCP. On a 429, wait for Retry-After.