List scheduled workflows

Returns a paginated list of scheduled workflows, ordered by next run date.

get/scheduled-workflows

Request

Base URL
https://public-api.process.st/api/v1.1
URL
https://public-api.process.st/api/v1.1/scheduled-workflows
Auth
- API key in header X-API-Key
- or HTTP bearer

Query parameters

workflowIdstring

Filter by workflow.

searchstring

Case-insensitive substring match on name.

_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

{
  "data": [
    {
      "workflowId": "nl9R_U1v89oBoZxtdQ50Rw",
      "createdBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "updatedBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.