Sign in
Deal

Get details of a deal

get/v1/deals/{id}

Path parameters

idinteger required

Deal identifier.

Response

OK

idinteger
namestring required

Name of the deal

contactIdinteger

ID of the related contact

companyIdinteger nullable

ID of the related company

pipelineIdinteger required

ID of the pipeline that this deal belongs to

stageIdinteger required

ID of the stage that this deal belongs to

departmentIdinteger

Department (brand) this deal belongs to. Derived from the pipeline on create (IDT-416).

orderNointeger required

Kanban stage order

createdUserIdinteger
createdDatestring date-time
updatedUserIdinteger
updatedDatestring date-time
createdContactIdinteger
createdAutomationIdinteger
ownerUserIdinteger

ID of the assigned user

ownerGroupIdinteger nullable

ID of the assigned group

followerIdsstring nullable

IDs of the users following this deal, separated by commas

expectedCloseDatestring date-time nullable

Expected close date in UTC (yyyy-MM-dd HH:mm:ss)

closingDatestring date-time nullable

Closing date in UTC (yyyy-MM-dd HH:mm:ss)

valuenumber double

Deal value

currencystring nullable

Deal currency in <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> format, defaults to user's or account's currency

notesstring nullable

Deal's description

lostReasonstring nullable

Null if the deal is not lost, otherwise the cause of losing this deal

sourceinteger required
status1 | 2 | 3 | 4 required
<p>Enum values:</p><ul><li><i>1 = Open</i></li><li><i>2 = Lost</i></li><li><i>3 = Won</i></li><li><i>4 = Deleted</i></li></ul>
lastStatusChangeDatestring date-time nullable
linkedType0 | 1 | 2 | 5 | 6 | 7 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 31 | 32 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 50 | 51 | 52 | 53 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 72

Infoset data objects<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Company</i></li><li><i>2 = Contacts</i></li><li><i>5 = Deals</i></li><li><i>6 = EmailLogs</i></li><li><i>7 = Emails</i></li><li><i>10 = MailAccounts</i></li><li><i>11 = MarketingLog</i></li><li><i>12 = MarketingSession</i></li><li><i>13 = MarketingTable</i></li><li><i>14 = Pipeline</i></li><li><i>15 = PipelineStages</i></li><li><i>16 = Todos</i></li><li><i>19 = TicketLogs</i></li><li><i>20 = Tickets</i></li><li><i>21 = Users</i></li><li><i>22 = Settings</i></li><li><i>23 = ContactGroups</i></li><li><i>25 = UserRights</i></li><li><i>26 = CustomUserRights</i></li><li><i>27 = UserGroups</i></li><li><i>31 = Automations</i></li><li><i>32 = Subjects</i></li><li><i>34 = Categories</i></li><li><i>35 = CallLogs</i></li><li><i>36 = Voicemails</i></li><li><i>37 = UserChannelRights</i></li><li><i>38 = CallCenterQueues</i></li><li><i>39 = DialPlans</i></li><li><i>40 = ServiceProviders</i></li><li><i>41 = IvrMenus</i></li><li><i>42 = IvrMenuDetails</i></li><li><i>43 = IvrPlugins</i></li><li><i>44 = VoipUsers</i></li><li><i>45 = DialerTable</i></li><li><i>46 = DialerSession</i></li><li><i>47 = DialerSessionLog</i></li><li><i>48 = DialerDtmfLink</i></li><li><i>50 = ChatRooms</i></li><li><i>51 = ChatTable</i></li><li><i>52 = ChatMessages</i></li><li><i>53 = ChatWidgets</i></li><li><i>55 = OutboundMessages</i></li><li><i>60 = ChatWidgetHomepage</i></li><li><i>61 = Chatbot</i></li><li><i>62 = ChatbotObject</i></li><li><i>63 = DealLogs</i></li><li><i>64 = SlaPolicies</i></li><li><i>65 = Sms</i></li><li><i>66 = Survey</i></li><li><i>67 = Announcements</i></li><li><i>68 = AnnouncementReadLogs</i></li><li><i>69 = AuditLogs</i></li><li><i>72 = Integrations</i></li></ul>

linkedIdinteger

Linked item ID

customFieldsstring nullable

A stringified JSON object mapping custom field names to values

Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}

categoryIdsstring nullable
isSpaminteger nullable

Example response

{
  "name": "Example deal",
  "currency": "USD"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.