Vixiees API

Sections

Theme switcher

Retrieves a deal

Header Parameters

X-Api-Keystring

Path Parameters

idstring Required

The ID or external_reference_id of the deal to retrieve

Response

200
Object

deal found

Response Attributes

idstring
titlestring | null
descriptionstring | null
statusstring
Enum values:
openwonlost
wonboolean
closedboolean
amountnumber | null
close_datestring | null
contact_idstring
assignee_idstring | null
closer_idstring | null
external_reference_idstring | null
closed_won_reasonstring | null
closed_lost_reasonstring | null
created_atstring | null
updated_atstring | null
custom_attributesarray

The value is stored in the *_value field matching field_type (e.g. string_value for string attributes).

Show child attributes

401
Object

unauthorized

404
Object

deal not found

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?