Skip to main content
An opportunity represents a deal in a pipeline stage. It is always linked to a lead. Use GET /pipelines to discover valid stage_id values before creating opportunities.

​
Opportunity object

FieldTypeDescription
idintegerUnique opportunity ID.
stage_idintegerPipeline stage ID.
lead_idintegerLinked lead ID.
valuenumberMonetary value.
confidenceintegerWin probability 0–100.
expected_close_datestringISO 8601 expected close date.
notestring | nullOptional note.
created_atstringISO 8601 creation timestamp.

​
Endpoints

List opportunities

GET /opportunities

Get opportunity

GET /opportunities/{id}

Create opportunity

POST /opportunities

Update opportunity

PUT /opportunities/{id}

Delete opportunity

DELETE /opportunities/{id}