---
title: "List schedules"
method: GET
path: "/api/v1/schedules"
tags: ["Schedules"]
---

# List schedules

`GET /api/v1/schedules`

## Query parameters

- `cursor` string — The page number for offset-based pagination.
- `pageSize` integer — Number of results per page (1-100, integer)
- `sortDirection` 'asc' | 'desc' — The direction to sort results (asc or desc).
- `sortField` 'scheduleName' | 'dashboardName' | 'ownerName' | 'lastRun' | 'lastRunStatus' — The field to sort results by. Valid values: scheduleName, dashboardName, ownerName, lastRun, lastRunStatus.
- `contentType` 'dashboard' | 'single tile' — Filter schedules by content type: dashboard, single tile.
- `embedEntity` string — Filter schedules by embed entity.
- `destination` 'email' | 'google_sheets' | 's3' | 'sftp' | 'slack' | 'webhook' — Filter schedules by destination type: email, slack, webhook, sftp, s3.
- `identifier` string — Filter schedules by the document's unique identifier. Can be found in the dashboard's URL after /dashboards/.
- `ownerId` string, uuid — Filter schedules by the owner's user ID. Use the List users endpoint to retrieve user IDs.
- `q` string — Search term for filtering schedules by name, dashboard name, or owner name (case-insensitive).
- `scheduleType` 'alert' | 'schedule' — Filter by type: alert, schedule.
- `status` 'success' | 'error' | 'canceled' | 'none' — Filter schedules by delivery status: success, error, canceled, none.

## Response `200`

Paginated list of schedules

- object
  - `pageInfo` PageInfo, required
    - `hasNextPage` boolean, required — Whether more results are available
    - `nextCursor` string, nullable, required — Cursor for fetching the next page
    - `pageSize` number, required — Number of results per page
    - `totalRecords` number, required — Total number of records matching the query
  - `records` SchedulesListItem[], required
    - `alert` object — Alert configuration (only present for alert-type schedules)
      - `conditionQueryName` string, nullable, required — Name of the query used for alert condition
      - `conditionType` string, required — Type of alert condition: RESULTS_CHANGED, RESULTS_PRESENT, RESULTS_MISSING
    - `content` string, required — Content type: dashboard or tile
    - `dashboardName` string, required — Name of the dashboard
    - `destinationType` string, required — Delivery destination type: email, slack, webhook, sftp, s3, google_sheets
    - `disabledAt` string, date-time, nullable, required — Timestamp when the schedule was paused (null if active)
    - `format` string, required — Output format: pdf, png, csv, xlsx, json, link_only
    - `id` string, uuid, required — Unique identifier for the schedule
    - `identifier` string, required — Dashboard identifier
    - `lastCompletedAt` string, date-time, nullable, required — Timestamp of last completed delivery
    - `lastStatus` string, nullable, required — Status of last delivery: COMPLETE, ERROR, ERROR_DELIVERED, KILLED, CONDITION_UNMET
    - `name` string, required — Name of the schedule
    - `ownerId` string, uuid, required — User ID of the schedule owner
    - `ownerName` string, required — Display name of the schedule owner
    - `recipientCount` number, required — Number of recipients (-1 for non-email destinations)
    - `schedule` string, required — AWS EventBridge cron expression (minute hour day-of-month month day-of-week year)
    - `slackRecipientType` string, nullable, required — Slack recipient type: Channel or Users (null for non-Slack)
    - `systemDisabledAt` string, date-time, nullable, required — Timestamp when system disabled the schedule (null if not system-disabled)
    - `systemDisabledReason` string, nullable, required — Reason for system disabling: missingQuery, noAccess, orphanedFilterConfigKeys
    - `timezone` string, required — IANA timezone for the schedule

## Other responses

- `401` — Authentication required
- `403` — Permission denied

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/de7cac8b5983/schema)