List schedules

Retrieves a list of all schedules associated with the authenticated user’s organization. If a project ID is provided in the header, the results are filtered to only include schedules for that project.

GET /utils/schedules

List schedules

cURL

curl --request GET \
  --url https://api.example.com/utils/schedules \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "schedule_id": "<string>",
    "schedule_name": "<string>",
    "schedule": {
      "type": "<string>",
      "cron": "<string>",
      "timezone": "<string>"
    },
    "reference_id": "<string>",
    "config": {
      "type": "<string>",
      "topic": "<string>",
      "extra_data": {}
    },
    "enabled": true
  }
]

Authorizations

Authorization · string · header · required

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

Headers

X-Project-ID · string | null

Response

200

application/json

Successful Response

schedule_id · string · required

ID of the schedule

schedule_name · string · required

Unique human readable name for the schedule

schedule · CronScheduleResponse · object · required

Cron-based schedule response with timezone-aware values.

The cron expression is dynamically converted from UTC back to the original timezone specified by the user for display purposes.

CronScheduleResponse

OneOffScheduleResponse

Show child attributes

reference_id · string · required

Reference ID (e.g. workflow config ID) held in Data Readiness resources

config · NotificationConfig · object · required

Schedule configuration (currently only NOTIFICATION is supported)

Show child attributes

enabled · boolean · required

Whether the schedule is ready to be triggered