Get a single schedule run

Retrieves a single schedule run by its ID, including the full schedule snapshot at execution time. The run must belong to the authenticated user’s organization.

GET /utils/schedules/runs/{run_id}

Get a single schedule run

cURL

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

200

{
  "id": "<string>",
  "schedule_id": "<string>",
  "organization_id": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "schedule_snapshot": {},
  "project_id": "<string>",
  "failure_reason": "<string>"
}

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

Path Parameters

run_id · string · required

ID of the schedule run to retrieve

Response

200

application/json

Successful Response

Detailed view of a single schedule run including the full schedule snapshot.

id · string · required

Unique ID of the schedule run

schedule_id · string · required

ID of the schedule that was executed

organization_id · string · required

Organization ID associated with the run

status · string · required

Execution status of the run (e.g. PENDING, SUCCESS, FAILURE)

created_at · string<date-time> · required

Timestamp when the run record was created (UTC)

schedule_snapshot · Schedule Snapshot · object · required

JSON snapshot of the schedule configuration at the time of execution

project_id · string | null

Optional project ID associated with the run

failure_reason · string | null

Optional description of how the task failed; empty when successful