Pipelines & deals
Sales pipelines, their stages, and the deals moving through them.
The deal object
As returned by GET /deals, one element of the list. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
titlerequired | string | What the deal is for |
valuerequired | number | Deal value as a number (the API coerces the decimal column) |
currencyrequired | string | null | ISO 4217 code |
statusrequired | string (enum) | Outcome; a deal is open until it is closedopenwonlost |
pipeline_idrequired | string (uuid) | UUID |
stage_idrequired | string (uuid) | UUID |
stagerequired | object | null | The stage the deal currently sits in |
stage.idrequired | string (uuid) | UUID |
stage.namerequired | string | Stage name |
contact_idrequired | string (uuid) | null | |
conversation_idrequired | string (uuid) | null | |
assigned_torequired | string (uuid) | null | Member user id |
notesrequired | string | null | Free-text notes on the deal |
expected_close_daterequired | string | null | YYYY-MM-DD |
created_atrequired | string (date-time) | ISO 8601 timestamp |
updated_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
9 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.