latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflows

List all workflows

Returns a list of active workflows. The workflows are returned 20 at a time, sorted by name. You must use the links section to get the next 20 results.

get/workflows

Query parameters

namestring

The partial name of the Workflow to search for (will match any part of the name in a case-insensitive manner)

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "workflows": [
    {
      "audit": {
        "createdBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        },
        "updatedBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      },
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}