Skip to content
Get started

List worker schedules

$ handinger workers:schedules list
GET/api/workers/{workerId}/schedules

List scheduled tasks for a worker.

ParametersExpand Collapse
--worker-id: string

Worker id returned by the create worker endpoint.

ReturnsExpand Collapse
WorkerScheduleListResponse: object { schedules, workerId }
schedules: array of WorkerSchedule
union_member_0: object { id, budget, input, 2 more }
id: string
budget: "low" or "standard" or "high" or "unlimited"
"low"
"standard"
"high"
"unlimited"
input: string
nextRunAt: string
type: "scheduled"
"scheduled"
union_member_1: object { id, budget, delayInSeconds, 3 more }
id: string
budget: "low" or "standard" or "high" or "unlimited"
"low"
"standard"
"high"
"unlimited"
delayInSeconds: number
input: string
nextRunAt: string
type: "delayed"
"delayed"
union_member_2: object { id, budget, cron, 3 more }
id: string
budget: "low" or "standard" or "high" or "unlimited"
"low"
"standard"
"high"
"unlimited"
cron: string
input: string
nextRunAt: string
type: "cron"
"cron"
union_member_3: object { id, budget, input, 3 more }
id: string
budget: "low" or "standard" or "high" or "unlimited"
"low"
"standard"
"high"
"unlimited"
input: string
intervalSeconds: number
nextRunAt: string
type: "interval"
"interval"
workerId: string

List worker schedules

handinger workers:schedules list \
  --api-key 'My API Key' \
  --worker-id t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM
{
  "schedules": [
    {
      "id": "id",
      "budget": "low",
      "input": "input",
      "nextRunAt": "2019-12-27T18:11:19.117Z",
      "type": "scheduled"
    }
  ],
  "workerId": "workerId"
}
Returns Examples
{
  "schedules": [
    {
      "id": "id",
      "budget": "low",
      "input": "input",
      "nextRunAt": "2019-12-27T18:11:19.117Z",
      "type": "scheduled"
    }
  ],
  "workerId": "workerId"
}