v6

latestSwagger 2.02026-08-0744314411.7 MB

schedules

Schedules

List Schedules

get/schedules

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are name.

Response

A list of Schedules objects.

idinteger

Schedule ID.

namestring

Schedule name.

schedule_days_of_weekinteger[]

0-based weekdays used by the Schedule. 0 is Sunday.

schedule_times_of_daystring[]

Times of day in HH:MM format (24-hour).

schedule_time_zonestring

Time zone for scheduled times. If not set, times are interpreted as UTC.

holiday_regionstring

Optional holiday region on which linked resources do not run.

human_readable_schedulestring

Human-readable Schedule description.

created_atstring date-time

Creation time.

updated_atstring date-time

Last update time.

Example response

[
  {
    "id": 1,
    "name": "Weekday overnight",
    "schedule_days_of_week": [
      1,
      2,
      3,
      4,
      5
    ],
    "schedule_times_of_day": [
      "01:00"
    ],
    "schedule_time_zone": "Eastern Time (US & Canada)",
    "holiday_region": "us",
    "human_readable_schedule": "Triggered every Monday, Tuesday, Wednesday, Thursday, Friday at 01:00 AM UTC TZ.",
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]