Skip to main content
Opportunities

Endpoints

Available endpoints for managing opportunities.

Opportunities

List Opportunities

Retrieve a paginated list of opportunities with optional filters.
Query Parameters:
Response:

Creation

Create an Opportunity

Create a new opportunity linked to an account.
Request body:
Required fields: name, accountId Response: 201 Created
Opportunity Details

Get an Opportunity

Retrieve full details of a specific opportunity.
Response:

Updates

Update an Opportunity

Update fields such as stage, probability, or outcome.
Example — close a deal:
Example — log a loss:
Response: 200 OK with the updated opportunity object.
Deletion

Delete an Opportunity

Permanently remove an opportunity.
Response: 204 No Content
Pipeline

Pipeline Stage Values