SalesOS.

Splits

Revenue split configuration

Splits Controller_get Opportunity Splits

GET
/api/opportunities/{opportunityId}/splits

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_create Split

POST
/api/opportunities/{opportunityId}/splits

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

opportunityIdRequiredstring
curl -X POST "https://www.salesos.org/api/api/opportunities/<string>/splits" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Splits Controller_update Split

PATCH
/api/opportunities/{opportunityId}/splits/{splitId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

opportunityIdRequiredstring
splitIdRequiredstring
curl -X PATCH "https://www.salesos.org/api/api/opportunities/<string>/splits/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Splits Controller_delete Split

DELETE
/api/opportunities/{opportunityId}/splits/{splitId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_approve Split

POST
/api/opportunities/{opportunityId}/splits/{splitId}/approve

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_reject Split

POST
/api/opportunities/{opportunityId}/splits/{splitId}/reject

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_get My Splits

GET
/api/splits/my-splits

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

statusRequiredstring
includeInForecastRequiredstring
curl -X GET "https://www.salesos.org/api/api/splits/my-splits?status=%3Cstring%3E&includeInForecast=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Splits Controller_get Team Splits

GET
/api/splits/team-splits

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

statusRequiredstring
userIdRequiredstring
curl -X GET "https://www.salesos.org/api/api/splits/team-splits?status=%3Cstring%3E&userId=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Splits Controller_get Split Stats

GET
/api/splits/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

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

Splits Controller_recalculate Split Amounts

POST
/api/opportunities/{opportunityId}/splits/recalculate

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_suggest Splits

GET
/api/opportunities/{opportunityId}/splits/ai/suggest

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_analyze Quota Impact

GET
/api/opportunities/{opportunityId}/splits/ai/quota-impact

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

opportunityIdRequiredstring
curl -X GET "https://www.salesos.org/api/api/opportunities/<string>/splits/ai/quota-impact" \
  -H "Authorization: Bearer <token>"

Splits Controller_detect Conflicts

GET
/api/opportunities/{opportunityId}/splits/ai/conflicts

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_get Analytics

GET
/api/opportunities/{opportunityId}/splits/ai/analytics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Splits Controller_get A I Recommendation

GET
/api/opportunities/{opportunityId}/splits/ai/recommendation

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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