Skip to main content
GET
List schedules

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

Query Parameters

runtime_target_kind
enum<string> | null

Deprecated: use listSourceSchedules. Source target of source_schedules when source_target_kind is omitted.

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

Deprecated: use listSourceSchedules. Environment that source_schedules is read from.

target_branch_id
string<uuid> | null

Deprecated: use listSourceSchedules. Preview branch that source_schedules is read from.

status
enum<string>
Available options:
active,
paused,
deleting
limit
integer
default:100

Maximum schedules per page. Defaults to 100.

Required range: 1 <= x <= 200
source_trigger_id
string
Required string length: 1 - 255
source_target_kind
enum<string>

Deprecated: use listSourceSchedules. Source target that source_schedules is read from.

Available options:
project,
main_branch,
environment,
preview_branch
sort_by
enum<string>
default:created_at
Available options:
created_at,
name
sort_order
enum<string>
default:desc
Available options:
asc,
desc
cursor
string<uuid>

The page_info.next of the previous page: the id of its last schedule. Keep the filters, sort_by and sort_order the same across pages. Only data is paged; the deprecated source_schedules is listed on the first page only.

Response

Lists recurring project schedules that trigger task, workflow, or agent runs.

data
object[]
required

The page of managed schedules.

schedules
object[]
required

Deprecated: the same page as data. Use data.

page_info
object
required

Pages data (and schedules) only. Pass next as cursor, with the same filters and sort, for the next page; it is null on the last page.

source_schedules
object[]

Deprecated: use listSourceSchedules. Schedules declared in project source, returned on the first page when a source selector is sent.

diagnostics
object[]

Deprecated: use listSourceSchedules. Source discovery diagnostics, returned with source_schedules.