v2

latestOpenAPI 3.1.02026-07-31822441.6 KB

Retrieve jobs schedule

Fetch the schedule for a tenant

get/{env_id}/{flow_id}/{tenant}/jobs/schedule

Path parameters

env_idstring required

ID of environment

flow_idstring required

ID of flow

tenantstring required

ID of tenant

Query parameters

job_type'read' | 'write'

Type of job to retrieve (Bidirectional flows only)

connector_idstring

ID of connector to retrieve. If not provided, flow level schedule will be returned.

Response

200

ScheduleExpressionstring
Statestring
ScheduleJitterMinutesinteger nullable
ExtraArgsobject

Example response

{
  "ScheduleExpression": "cron(0 0 ? * SUN *)",
  "State": "DISABLED",
  "ScheduleJitterMinutes": 60,
  "ExtraArgs": {
    "override_start_date": "2000-01-01"
  }
}