workflows endpoint is accessible at The following actions are supported on workflows endpoint:

REST API Test Framework

Please visit our REST API Test Framework to test the queries in this page and see the results. Resuls are not shwown here for simiplicity.


GET HTTP method is used to retrieve a list of workflows

  • List all workflows:
curl -X GET -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"

Number of Returned Results

The number of returned results is limited to 20 by default (Results Pagination).

  • Get workflow by ID:
curl -X GET -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"
  • Get workflow by a property:
curl -X GET -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"

Query Parameter

The query parameter before encoding is query={"name": "Total Energy"}.


POST HTTP method is used to create a new workflow. Workflow properties should be passed in JSON format inside body.

curl -X POST -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ" -d
    // JSON data source...


DELETE HTTP method is used to delete a workflow with a given id.

curl -X DELETE
  "status": "success",
  "data": {
    "message": "Workflow SxiKuakDhSQaCAnTC successfully deleted"


PATCH HTTP method is used to update an existing workflow with a given ID.

curl -X PATCH -d '{"name": "Total Energy 2"}'