v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Deal

Retrieves a Deal resource.

get/deals/{id}

Path parameters

idstring required

Resource identifier

Response

Deal resource

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

ownerIdstring nullable

User Id of deal responible

ownerNamestring nullable

User name of deal responsible

stagestring nullable

Deal's stage e.g: decision

dealNamestring nullable

name of the deal

descriptionstring nullable

Details about the deal

prospectIdstring nullable

Id of the prospect customer the deal is related to

prospectNamestring nullable

name of the customer the deal is related to

expectedRevenueinteger nullable

expected revenue from the deal

currencystring nullable

currency code of the deal e.g: USD

createdstring nullable

date and time the deal is first created

closedstring date-time nullable

date and time the deal is closed

associatedContactIdsstring[] nullable

A list of contact IDs that are associated with the deal

associatedCompanyIdsstring[] nullable

A list of company IDs that are associated with the deal

numAssociatedContactsinteger nullable

The number of associated contacts

Example response

{
  "id": "quickbooks-726",
  "integration": "quickbooks",
  "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  "ownerName": "Dave Simpson",
  "stage": "decision",
  "currency": "USD",
  "created": "2021-07-28 00:00:00",
  "closed": "2021-07-28 00:00:00",
  "numAssociatedContacts": 5
}