Skip to main content
GET
Get schedule

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
Minimum string length: 1
schedule_id
string<uuid>
required

Schedule ID.

Response

Project schedule

Recurring project schedule.

id
string<uuid>
required

Schedule ID.

project_id
string<uuid>
required

Owning project ID.

name
string
required

Human-readable schedule name.

status
enum<string>
required

Schedule status.

Available options:
active,
paused,
deleting
paused_reason
string | null
required

System pause reason when Veryfront pauses the schedule.

paused_at
string | null
required

Timestamp when Veryfront paused the schedule.

last_failure_at
string | null
required

Timestamp of the most recent schedule failure.

last_failure_code
string | null
required

Most recent schedule failure code.

last_failure_message
string | null
required

Most recent schedule failure message.

last_failure_run_id
string<uuid> | null
required

Canonical run ID for the most recent schedule failure.

target
object
required

Typed schedule target.

schedule
string
required

Schedule expression.

timezone
string
required

IANA timezone.

runtime_target_kind
enum<string>
required

Runtime target kind.

Available options:
main_branch,
environment,
preview_branch
runtime_target_environment_id
string<uuid> | null
required

Environment ID for environment schedules.

runtime_target_branch_id
string<uuid> | null
required

Branch ID for preview branch schedules.

config
object
required

Run configuration without internal schedule target metadata.

timeout_seconds
integer
required

Per-run timeout in seconds.

backoff_limit
integer
required

Retry backoff limit.

concurrency_policy
string
required

How overlapping scheduled runs are handled.

definition_source
enum<string>
required

Whether the schedule is manually managed or source-defined.

Available options:
manual,
source
source_trigger_id
string | null
required

Source trigger ID for source-defined schedules.

source_path
string | null
required

Source file path for source-defined schedules.

source_hash
string | null
required

Source definition hash for source-defined schedules.

last_scheduled_at
string | null
required

Last scheduled fire time.

last_successful_at
string | null
required

Last successful run time.

health
object | null
required

Optional staleness budget used for schedule health alerting.

max_runs
integer | null
required

Optional maximum run count.

run_count
integer
required

Fire reservations counted toward the repetition limit; released reservations are subtracted.

Required range: x >= 0
completed_at
string | null
required

Completion time for finite schedules.

created_by
string<uuid> | null
required

User that created the schedule.

created_at
string
required

Creation timestamp.

updated_at
string
required

Last update timestamp.

integration_requirements
object[]

OAuth scopes and exact provider resources required before the schedule can run.

Maximum array length: 20