API v1 ReferenceAgent Schedules

Lists owned schedules.

Lists schedules owned by the requesting user whose active agents remain readable. The overview processes the newest 1,000 owned schedules. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Response

OK
namestring or nullOptional
The schedule display name.
idstringOptionalformat: "uuid"
The schedule id.
createdOnstringOptionalformat: "date-time"
When the schedule was created.
agentIdstringOptionalformat: "uuid"
The agent id that is executed by this schedule.
ownerUserIdstringOptionalformat: "uuid"
The user id whose context is used to execute the scheduled run.
promptstring or nullOptional
Optional custom instructions. An omitted or null prompt means no custom instructions.
cronRulestring or nullOptional
The normalized cron rule used for recurring execution.
recurrenceIntervalintegerOptional
The number of matching cron occurrences between scheduled runs.
timezonestring or nullOptional
The timezone used to evaluate the cron rule.
projectIdstring or nullOptionalformat: "uuid"
The optional project context id.
taskIdstring or nullOptionalformat: "uuid"
The optional task context id.
isEnabledbooleanOptional
Whether this schedule is active.
needsAttentionbooleanOptional
Whether the schedule needs user attention.
lastFailureReasonstring or nullOptional
The latest rejection reason.
consecutiveFailureCountintegerOptional
The number of consecutive failed scheduled executions.
lastAttemptOnstring or nullOptionalformat: "date-time"
The latest occurrence time.
lastSuccessfulRunOnstring or nullOptionalformat: "date-time"
The latest accepted occurrence time.