Get deal

Retrieves deal details by ID.

Path Parameters

  • id: Deal ID

Response Fields

FieldTypeDescription
idintegerUnique identifier
uidstringUUID v7 (for public links)
numberstringDeal number (D-YYYY-N)
namestringDeal name
ownerobjectOwner
customerobjectAssociated customer
companyobjectCompany
archivedbooleanArchived deal
templatebooleanTemplate deal
autoSavebooleanAuto-save
languagestringDeal language
contactFullNamestringContact full name
opportunityAmountHtnumberTotal amount excl. tax
opportunityAmountTtcnumberTotal amount incl. tax
primaryQuotationIdintegerPrimary quotation ID
primaryQuotationUuidstringPrimary quotation UUID
quotationsarrayList of quotations
dealViewLinksarrayView links
presentationsarrayAssociated presentations
created_atdatetimeCreation date
updated_atdatetimeLast update date
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Responses
200

Successful response

401

Unauthorized

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