Get Schedules By Tag

Endpoint: GET /api/scheduler/schedules/tag

Retrieves schedules using a specific tag.

Query parameters

Parameter	Description	Type	Required/Optional
tag	The tag as a key-value pair. For example, “someKey:someValue”.	string	Required.

Response

Returns an array of schedule details.

Examples

Get a list of schedules with a specific tag

Request

curl -X 'GET' \
  'https://<YOUR-CLUSTER>/api/scheduler/schedules/tags?tag=team%3Adocs' \
  -H 'accept: application/json' \
  -H 'X-Authorization: <TOKEN>'

Response

[
  {
    "name": "assignPR",
    "cronExpression": "0 * * ? * *",
    "runCatchupScheduleInstances": false,
    "paused": true,
    "startWorkflowRequest": {
      "name": "github_pr_reviewer_assignment",
      "version": 2,
      "correlationId": "",
      "input": {},
      "taskToDomain": {},
      "priority": 0
    },
    "zoneId": "UTC",
    "createTime": 1748866217788,
    "updatedTime": 1748866349489,
    "createdBy": "john.doe@acme.com",
    "updatedBy": "john.doe@acme.com",
    "description": "Sample scheduler for running workflow every 2 mins",
    "orgId": "0000",
    "queueMsgId": "assignPR"
  }
]