SalesOS.

Approval Workflows

Multi-step approval processes

Approval Workflows Controller_get Stats

GET
/v1/approval-workflows/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

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

Approval Workflows Controller_find All

GET
/v1/approval-workflows

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

entityRequiredstring
isActiveRequiredstring
curl -X GET "https://api.salesos.org/v1/approval-workflows?entity=%3Cstring%3E&isActive=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Approval Workflows Controller_create

POST
/v1/approval-workflows

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired
curl -X POST "https://api.salesos.org/v1/approval-workflows" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Approval Workflows Controller_find By Entity

GET
/v1/approval-workflows/entity/{entity}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

entityRequiredstring
curl -X GET "https://api.salesos.org/v1/approval-workflows/entity/<string>" \
  -H "Authorization: Bearer <token>"

Approval Workflows Controller_check Approval Required

GET
/v1/approval-workflows/check/{entityType}/{entityId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

entityTypeRequiredstring
entityIdRequiredstring
curl -X GET "https://api.salesos.org/v1/approval-workflows/check/<string>/<string>" \
  -H "Authorization: Bearer <token>"

Approval Workflows Controller_find One

GET
/v1/approval-workflows/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Approval Workflows Controller_update

PATCH
/v1/approval-workflows/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

idRequiredstring
curl -X PATCH "https://api.salesos.org/v1/approval-workflows/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Approval Workflows Controller_delete

DELETE
/v1/approval-workflows/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

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

Approval Workflows Controller_clone

POST
/v1/approval-workflows/{id}/clone

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/approval-workflows/<string>/clone" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Approval Workflows Controller_toggle Active

POST
/v1/approval-workflows/{id}/toggle-active

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/approval-workflows/<string>/toggle-active" \
  -H "Authorization: Bearer <token>"

Approval Workflows Controller_add Step

POST
/v1/approval-workflows/{workflowId}/steps

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

workflowIdRequiredstring
curl -X POST "https://api.salesos.org/v1/approval-workflows/<string>/steps" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Approval Workflows Controller_update Step

PATCH
/v1/approval-workflows/{workflowId}/steps/{stepId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

workflowIdRequiredstring
stepIdRequiredstring
curl -X PATCH "https://api.salesos.org/v1/approval-workflows/<string>/steps/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Approval Workflows Controller_delete Step

DELETE
/v1/approval-workflows/{workflowId}/steps/{stepId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

workflowIdRequiredstring
stepIdRequiredstring
curl -X DELETE "https://api.salesos.org/v1/approval-workflows/<string>/steps/<string>" \
  -H "Authorization: Bearer <token>"

Approval Workflows Controller_reorder Steps

POST
/v1/approval-workflows/{workflowId}/steps/reorder

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired

Path Parameters

workflowIdRequiredstring
curl -X POST "https://api.salesos.org/v1/approval-workflows/<string>/steps/reorder" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'