Skip to content

Get a deal

GET
/api/v1/deals/{id}
id
required
string format: uuid
include
string
Allowed values: associations

Success

object
id
required
string format: uuid
organization_id
required
string format: uuid
name
required
string
pipeline_id
required
string format: uuid
stage_id
required
string format: uuid
status

The kind of the deal’s stage: open, won or lost. Derived, read-only.

string
Allowed values: open won lost
amount_minor
required
integer | null
currency
required
string | null
expected_close_date
required
string | null
owner_id
required
string | null format: uuid
closed_at
required
string | null
created_by
required
string format: uuid
created_at
required
string
updated_at
required
string
associations
Array<object>
object
id
required
string format: uuid
relation
required
string
Allowed values: related_to
neighbour_type
required
string
neighbour_id
required
string format: uuid
created_by
required
string format: uuid
created_at
required
string
associations_truncated
boolean