SalesOS.

Opportunities

Opportunity tracking and pipeline

Opportunities Controller_find All

GET
/api/opportunities

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

stageRequiredstring
accountIdRequiredstring
isClosedRequiredstring
minAmountRequiredstring
searchRequiredstring
sourceRequiredstring
cursorRequiredstring
limitRequiredstring
curl -X GET "https://www.salesos.org/api/api/opportunities?stage=%3Cstring%3E&accountId=%3Cstring%3E&isClosed=%3Cstring%3E&minAmount=%3Cstring%3E&search=%3Cstring%3E&source=%3Cstring%3E&cursor=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_create

POST
/api/opportunities

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://www.salesos.org/api/api/opportunities" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_get Pipeline Stats

GET
/api/opportunities/pipeline/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://www.salesos.org/api/api/opportunities/pipeline/stats" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_get Forecast

GET
/api/opportunities/forecast

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://www.salesos.org/api/api/opportunities/forecast" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_get Contacts

GET
/api/opportunities/{id}/contacts

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://www.salesos.org/api/api/opportunities/<string>/contacts" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_add Contact

POST
/api/opportunities/{id}/contacts

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/contacts" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_find One

GET
/api/opportunities/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://www.salesos.org/api/api/opportunities/<string>" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_update

PATCH
/api/opportunities/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X PATCH "https://www.salesos.org/api/api/opportunities/<string>" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_remove

DELETE
/api/opportunities/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://www.salesos.org/api/api/opportunities/<string>" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_advance Stage

POST
/api/opportunities/{id}/advance

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/advance" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_close Won

POST
/api/opportunities/{id}/close-won

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/close-won" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_close Lost

POST
/api/opportunities/{id}/close-lost

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/close-lost" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_analyze

POST
/api/opportunities/{id}/analyze

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/analyze" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_update Contact

PATCH
/api/opportunities/{id}/contacts/{contactId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
contactIdRequiredstring
curl -X PATCH "https://www.salesos.org/api/api/opportunities/<string>/contacts/<string>" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_remove Contact

DELETE
/api/opportunities/{id}/contacts/{contactId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
contactIdRequiredstring
curl -X DELETE "https://www.salesos.org/api/api/opportunities/<string>/contacts/<string>" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_set Primary Contact

POST
/api/opportunities/{id}/contacts/{contactId}/set-primary

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
contactIdRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/contacts/<string>/set-primary" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_bulk Update

POST
/api/opportunities/bulk/update

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://www.salesos.org/api/api/opportunities/bulk/update" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_bulk Delete

POST
/api/opportunities/bulk/delete

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://www.salesos.org/api/api/opportunities/bulk/delete" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_bulk Assign

POST
/api/opportunities/bulk/assign

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://www.salesos.org/api/api/opportunities/bulk/assign" \
  -H "Authorization: Bearer <token>"

Opportunities Controller_bulk Update Stage

POST
/api/opportunities/bulk/stage

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://www.salesos.org/api/api/opportunities/bulk/stage" \
  -H "Authorization: Bearer <token>"

Accounts

Account/company management

Pipelines

Sales pipeline configuration