latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

opportunities

Retrieve an opportunity

get/opportunity/{id}/

Path parameters

idstring required

Query parameters

_fieldsstring

Comma-separated list of fields to include in the response.

Response

Successful response

annualized_expected_valueinteger nullable required
annualized_valueinteger nullable required
confidenceinteger required
contact_idstring nullable required
contact_namestring nullable
created_bystring nullable required
created_by_namestring nullable
date_createdstring date-time required
date_loststring date-time nullable required
date_updatedstring date-time required
date_wonstring date nullable required
expected_valueinteger nullable required
idstring required
is_stalledboolean
lead_idstring required
lead_namestring nullable
notestring nullable required
note_htmlstring nullable required
organization_idstring required
pipeline_idstring nullable
pipeline_namestring nullable
status_display_namestring
status_idstring required
status_labelstring
status_type'won' | 'lost' | 'active'
updated_bystring nullable required
updated_by_namestring nullable
user_idstring required
user_namestring nullable
valueinteger nullable required
value_currencystring nullable
value_formattedstring nullable
value_period'one_time' | 'monthly' | 'annual' required