Opportunities

Operations related to opportunities

Get all Opportunities

get

Returns a list of opportunities with pagination support.

Authorizations
x-api-keystringRequired
Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

namestringOptional

Opportunity name to filter opportunities by (partial match).

contactIdstringOptional

Contact ID to filter opportunities by contact relationship.

Responses
chevron-right
200Success
application/json
get
/api/v1/opportunities

Create Opportunity

post

Creates a new opportunity.

Authorizations
x-api-keystringRequired
Body
namestringRequired

Name of the opportunity

Example: Enterprise Software License
amountnumberOptional

Opportunity amount

Example: 50000
finalAmountnumberOptional

Final opportunity amount

Example: 45000
riskstring · enumOptional

Opportunity risk level

Example: LowPossible values:
prioritystring · enumOptional

Opportunity priority level

Example: HighPossible values:
descriptionstringOptional

Opportunity description

Example: Enterprise software license for 500 users
featuredNotesstringOptional

Featured notes for the opportunity

Example: Key decision maker is the CTO
nextStepstringOptional

Next step for the opportunity

Example: FollowUp
closeDatestring · date-timeOptional

Actual close date

Example: 2024-03-10T00:00:00.000Z
closeProbabilitynumberOptional

Close probability (0-100)

Example: 75
statusstring · enumOptional

Opportunity status

Example: openPossible values:
Responses
post
/api/v1/opportunities

Get Opportunity by ID

get

Get an opportunity by ID.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID to retrieve.

Responses
chevron-right
200Success
application/json
get
/api/v1/opportunities/{id}

Update Opportunity

put

Updates an existing opportunity.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID to update.

Body
namestringOptional

Name of the opportunity

Example: Enterprise Software License
amountnumberOptional

Opportunity amount

Example: 50000
finalAmountnumberOptional

Final opportunity amount

Example: 45000
riskstring · enumOptional

Opportunity risk level

Example: LowPossible values:
prioritystring · enumOptional

Opportunity priority level

Example: HighPossible values:
descriptionstringOptional

Opportunity description

Example: Enterprise software license for 500 users
featuredNotesstringOptional

Featured notes for the opportunity

Example: Key decision maker is the CTO
nextStepstringOptional

Next step for the opportunity

Example: FollowUp
closeDatestring · date-timeOptional

Actual close date

Example: 2024-03-10T00:00:00.000Z
closeProbabilitynumberOptional

Close probability (0-100)

Example: 75
statusstring · enumOptional

Opportunity status

Example: openPossible values:
Responses
chevron-right
200Success
application/json
put
/api/v1/opportunities/{id}

Delete Opportunity

delete

Deletes an opportunity by ID.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID to delete.

Responses
chevron-right
200Success
application/json
delete
/api/v1/opportunities/{id}

Get Opportunity Integrations

get

Returns a list of integrations for a given opportunity ID.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID to get integrations from.

Responses
chevron-right
200Success
application/json
get
/api/v1/opportunities/{id}/integrations

Get Opportunity Contacts

get

Returns a list of contacts associated with an opportunity.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID to get contacts from.

Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses
chevron-right
200Success
application/json
get
/api/v1/opportunities/{id}/contacts

Create Opportunity Contact Relationship

post

Creates a relationship between an opportunity and a contact.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID.

Body
contactIdstringRequired

Contact ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Responses
post
/api/v1/opportunities/{id}/contacts

Get Opportunity Companies

get

Returns a list of companies associated with an opportunity.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID to get companies from.

Query parameters
pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses
chevron-right
200Success
application/json
get
/api/v1/opportunities/{id}/companies

Create Opportunity Company Relationship

post

Creates a relationship between an opportunity and a company.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
Body
companyIdstringRequired

Company ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d
Responses
post
/api/v1/opportunities/{id}/companies

Delete Opportunity Contact Relationship

delete

Deletes a relationship between an opportunity and a contact.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired

Opportunity ID.

contactIdstringRequired

Contact ID.

Responses
chevron-right
200Success
application/json
delete
/api/v1/opportunities/{id}/contacts/{contactId}

Delete Opportunity Company Relationship

delete

Deletes a relationship between an opportunity and a company.

Authorizations
x-api-keystringRequired
Path parameters
idstringRequired
companyIdstringRequired

Company ID.

Responses
chevron-right
200Success
application/json
delete
/api/v1/opportunities/{id}/companies/{companyId}

Last updated

Was this helpful?