Skip to main content
GET
Retrieve schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_key
string
required

The unique routing key of the agent the schedule belongs to.

schedule_id
string
required

The schedule's ULID, as returned from create.

Response

Schedule retrieved.

_id
string
required

ULID identifying this schedule.

agent_key
string
required
created
string<date-time>
required
created_by_id
string
required

ID of the API key that created the schedule.

expression
string
required

Cron expression (6-field, seconds required), @every duration, @at RFC3339 timestamp, or a predefined descriptor like @hourly/@daily.

generation
integer<int64>
required

Monotonic counter bumped when the schedule's firing cadence changes. Used by the consumer to skip stale in-flight triggers.

is_active
boolean
required

Whether the schedule is currently firing. once schedules flip to false automatically after firing.

payload
object
required
trigger_count
integer<int64>
required

Total firings since creation or last expression/type change.

type
enum<string>
required

Schedule type.

Available options:
cron,
once,
interval
updated
string<date-time>
required
agent_tag
string

Pinned agent version. Omit to always run the agent's current active version.

last_triggered_at
string<date-time>

Timestamp of the most recent firing, if any.