Get quotation

Retrieves a single quotation by its ID.

Path Parameters

ParameterTypeRequiredDescription
idintegerYesQuotation ID

Response Fields (signature-related)

FieldTypeDescription
signedbooleanWhether the quotation is signed
signDatedatetimeDate and time of signature (null if not signed)
signerFirstNamestringFirst name of the signer
signerLastNamestringLast name of the signer
signerEmailstringEmail of the signer
signedPdfUrlstringPublic URL of the signed PDF (null if not signed)

Response Fields (quotation-v2 builder)

FieldTypeDescription
blocksarray|nullOrdered list of content blocks (dynamic zone). Order = display order, top to bottom. See "Blocks" below.
shareLinksarray|nullPer-quotation filtered views of the block list. See "Share links" below.

Blocks

Each entry of blocks is a block envelope:

FieldTypeDescription
idstringStable unique block id (kept stable across edits)
typestringBlock type key (see catalog)
versionintegerSchema version of the block
visiblebooleanShown on the client/front side when true
titlestringBlock title (card header)
layoutobject{ columns, rows } (effective only on blocks that support columns)
dataobjectBlock-specific payload (shape depends on type)

Some blocks store their displayed content on the quotation/deal entity (lines,
custom field values, title, number…) rather than in data — do not duplicate it.

Block type catalog (type ⇒ purpose):

typePurposelayout.columns
headerCover image + logo, quotation title/number
contactsSales rep + client (company, billing address)
wysiwygRich text (TipTap), multi-column1–3
htmlRaw HTML/CSS/JS embed (DuoDeal micro-app)
pricingPrice table; lines scoped by line.blockId
customfieldsQuotation-scope custom fields (label + value)1–3
attachmentsDownloadable files from the media library1–3
legalnoticeCompany info + legal text
paymentscheduleDeposit + installments plan
pdfviewerEmbed a single PDF
youtubeOne or more YouTube videos1–3
faqQuestion/answer accordion
pptxEmbed a PowerPoint/Office doc (Office Online viewer)
googleslidesEmbed Google Slides
canvaEmbed a Canva design
galleryImage grid + lightbox1–6
acceptClient "Accept & Sign" button
signstampSignature stamp (shown once signed)
pagebreakForce a new page in the PDF export

A brand-new quotation is pre-loaded with the default blocks ["header", "contacts"].

Share links

Each entry of shareLinks records only the deviations from the full block view:

FieldTypeDescription
idstringStable unique share-link id
namestringDisplay name of the link
hiddenBlocksarrayBlock ids hidden for this link
optionsobjectPer-block share options keyed by block id (e.g. { "<blockId>": { "hidePrices": true } })

Response

  • 200 OK: Returns the quotation
  • 401 Unauthorized: Invalid or missing API key
  • 404 Not Found: Quotation not found
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses
200

Successful response

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!