List schedule runs

Retrieves a paginated list of schedule runs for the authenticated user’s organization. Results can be optionally filtered by project ID and ordered by creation time.

GET /utils/schedules/runs

List schedule runs

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "schedule_id": "<string>",
      "organization_id": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "project_id": "<string>",
      "failure_reason": "<string>"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "total_items": 1,
    "total_pages": 1,
    "next_page": 123,
    "prev_page": 123
  }
}

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

Query Parameters

page · integer · default: 1

Page number (starts at 1)

Required range: x >= 1

limit · integer · default: 20

Items per page

Required range: 1 <= x <= 100

order · string · default: desc

Order by created_at. 'desc' (most recent first) or 'asc' (oldest first).

Pattern: ^(asc|desc)$

schedule_id · string | null

Optional schedule ID to filter runs for a single schedule.

Response

200

application/json

Successful Response

Paginated list response for schedule runs.

data · ScheduleRunSummary · object[] · required

Show child attributes

pagination · Pagination · object · required

Pagination metadata for list responses.

Show child attributes