List schedules

GET

/schedules

• Production

Requires: tasks.schedule.read

Authorizations

• bearerAuth

Parameters

Header Parameters

x-uai-org

string

Org scope: me or an org slug. Absent means the caller’s active/personal org. It selects the workspace used for permission checks and for most resource filters; operation-specific access rules still apply.

Responses

200

Successful response.

object

schedules

required

Array<object>

object

id

required

ULID

string

name

required

string

cron

required

Five-field cron expression

string

timezone

required

IANA timezone the cron is evaluated in

string

enabled

required

boolean

overlapPolicy

required

What to do when the previous run is still going

string

misfirePolicy

required

What to do when a fire time was missed

string

nextRunAt

required

Epoch milliseconds

integer

lastRunAt

required

Any of:

integer

Epoch milliseconds

integer

null

null

failureStreak

required

integer

disabledReason

required

Set when the system disabled it

string | null

templateTaskId

required

Task this schedule clones on each run

string

ownerUserId

required

string

lastRun

required

Any of:

object

object

id

required

ULID

string

dueAt

required

When this run was scheduled to fire

integer

trigger

required

What caused the run — a tick, or a manual run

string

state

required

Lifecycle state of the run

string

taskId

required

Task the run created, once it has one

string | null

errorCode

required

string | null

errorMessage

required

string | null

skipReason

required

Why the run did not start: a missed fire time, an overlapping previous run, the schedule having been paused, rescheduled or deleted, or a task left starting by a managed-runner restart. Prose, not an enum — do not branch on it.

string | null

createdAt

required

Epoch milliseconds

integer

settledAt

required

Any of:

integer

Epoch milliseconds

integer

null

null

null

null

description

required

The cron expression in prose

string

upcoming

required

The next few fire times, derived at read time

Array<integer>

401

UNAUTHORIZED — missing or invalid token, or an org-scoped API key (only user-scoped keys are accepted).

object

error

required

object

code

required

Stable, machine-readable error code

string

message

required

Human-readable explanation

string

details

permission

Present on 403 — the permission the caller lacked

string

feature

Present on 402 — gated feature

string

limit

Present on 402 — the plan’s cap

number

plan

Present on 402 — the current plan

string

seats

Present on 402 when the cap is seat-derived

object

seats

required

Effective seats the cap was computed from

integer

seatsMax

required

Any of:

integer

integer

null

null

perSeat

required

Units of the resource each seat carries

number

key

additional properties

any

402

PLAN_LIMIT — the workspace’s plan does not include API access. Every API-key call can return this; session-token calls never do.

object

error

required

object

code

required

Stable, machine-readable error code

string

message

required

Human-readable explanation

string

details

permission

Present on 403 — the permission the caller lacked

string

feature

Present on 402 — gated feature

string

limit

Present on 402 — the plan’s cap

number

plan

Present on 402 — the current plan

string

seats

Present on 402 when the cap is seat-derived

object

seats

required

Effective seats the cap was computed from

integer

seatsMax

required

Any of:

integer

integer

null

null

perSeat

required

Units of the resource each seat carries

number

key

additional properties

any

403

FORBIDDEN (lacking the required permission) or SCOPE_REQUIRED (no workspace, or a membership change in progress).

object

error

required

object

code

required

Stable, machine-readable error code

string

message

required

Human-readable explanation

string

details

permission

Present on 403 — the permission the caller lacked

string

feature

Present on 402 — gated feature

string

limit

Present on 402 — the plan’s cap

number

plan

Present on 402 — the current plan

string

seats

Present on 402 when the cap is seat-derived

object

seats

required

Effective seats the cap was computed from

integer

seatsMax

required

Any of:

integer

integer

null

null

perSeat

required

Units of the resource each seat carries

number

key

additional properties

any

404

SCOPE_REQUIRED — the x-uai-org scope names a workspace that does not exist, or one the caller is not a member of. The two are deliberately indistinguishable: a 403 would confirm the workspace exists.

object

error

required

object

code

required

Stable, machine-readable error code

string

message

required

Human-readable explanation

string

details

permission

Present on 403 — the permission the caller lacked

string

feature

Present on 402 — gated feature

string

limit

Present on 402 — the plan’s cap

number

plan

Present on 402 — the current plan

string

seats

Present on 402 when the cap is seat-derived

object

seats

required

Effective seats the cap was computed from

integer

seatsMax

required

Any of:

integer

integer

null

null

perSeat

required

Units of the resource each seat carries

number

key

additional properties

any

503

SCOPE_REQUIRED — membership reconciliation required, or membership verification unavailable.

object

error

required

object

code

required

Stable, machine-readable error code

string

message

required

Human-readable explanation

string

details

permission

Present on 403 — the permission the caller lacked

string

feature

Present on 402 — gated feature

string

limit

Present on 402 — the plan’s cap

number

plan

Present on 402 — the current plan

string

seats

Present on 402 when the cap is seat-derived

object

seats

required

Effective seats the cap was computed from

integer

seatsMax

required

Any of:

integer

integer

null

null

perSeat

required

Units of the resource each seat carries

number

key

additional properties

any