---
title: "Data feed for schedules"
method: GET
path: "/scheduling/v1/feed/schedules"
tags: ["Data Feeds"]
---

# Data feed for schedules

`GET /scheduling/v1/feed/schedules`

## Query parameters

- `limit` integer
- `show_active` boolean
- `show_finished` boolean
- `show_paused` boolean
- `template` string[]
- `next_page_token` string

## Response `200`

A successful response.

- S12SchedulingFeedV1FeedSchedulesResponse — The response for `FeedSchedules` V2
  - `metadata` S12CommonV1FeedMetadataSimple — FeedMetadataSimple for a feed.
    - `next_page` string — Full path to retrieve the next page of results, including the next_page_token.
    - `next_page_token` string — The value you can use to retrieve additional results. If a value exists, it means there are more results than listed. Use the value in your request body as a page_token to view more results.
  - `data` S12SchedulingFeedV1FeedScheduleRecord[] — The flat list of schedule records.
    - `id` string — Unique identifier for this schedule. Format: `scheduleitem_{schedule_id}` Example: `scheduleitem_123`.
    - `title` string — Display name of the schedule. For example, `Weekly Safety Inspection` or `Monthly Equipment Check`.
    - `recurrence` string — Schedule recurrence pattern in RFC 5545 RRule format. For example, `FREQ=DAILY`, `FREQ=WEEKLY;BYDAY=MO,WE,FR`, `FREQ=MONTHLY;BYMONTHDAY=1` See: https://tools.ietf.org/html/rfc5545#section-3.3.10.
    - `duration` string — Expected inspection duration (ISO 8601 duration format; for example, `PT30M` (30 minutes), `PT2H` (2 hours), `PT1H30M` (1.5 hours).
    - `modified_at` string, date-time — Last updated timestamp (UTC format).
    - `organisation_id` string — ID of the organization that owns this schedule.
    - `created_at` string, date-time — Created timestamp (UTC format).
    - `completion_rule` string — Completion requirement for the scheduled inspection. One of: `any` (at least one assignee must complete) or `all` (every assignee must complete).
    - `status` string — Current operational status of the schedule. • `ACTIVE`: Schedule is running and creating occurrences. • `PAUSED`: Schedule is temporarily stopped. • `FINISHED`: Schedule has ended (past end date or max occurrences).
    - `timezone` string — Timezone for schedule execution (IANA timezone identifier). For example, `America/New_York`, `Europe/London` or `UTC`.
    - `timezone_type` string — How the schedule's timezone is determined. • `CUSTOM_TIMEZONE`: Uses the timezone specified in the 'timezone' field. • `SITE_TIMEZONE`: Uses the timezone of the site where inspection occurs.
    - `is_late_submit_allowed` boolean — Whether inspections can be started after the due date.
    - `site_ids` string[] — Site IDs where the schedule is performed. May be empty for non-site-based schedules.
    - `template_id` string — Template ID associated with the schedule.
    - `created_by` string — ID of the user who created the schedule.
    - `grace_period_duration` string — Grace period duration in ISO 8601 format. For example, `PT1H`.
    - `site_based_assignment_enabled` boolean — Whether to use site-based assignees.
    - `ending_rule_type` string — How the schedule ends: `never`, `end_date`, or `end_after_repeats`.
    - `ending_rule_end_date` string — End date when ending_rule_type is `end_date` (ISO datetime string). • Only populated when `ending_rule_type` = `end_date`.
    - `ending_rule_end_after_repeats` integer — Number of repeats when `ending_rule_type` is `end_after_repeats`. • Only populated when `ending_rule_type` = `end_after_repeats`.
    - `assignees` string[] — Assignee IDs.
    - `intersections` string[] — Intersection group IDs (if schedule is using site+group intersection-based assignment).
    - `schedule_type` 'SCHEDULE_TYPE_UNSPECIFIED' | 'SCHEDULE_TYPE_USERS' | 'SCHEDULE_TYPE_SITES' | 'SCHEDULE_TYPE_ASSETS' — - SCHEDULE_TYPE_UNSPECIFIED: Unspecified schedule type - SCHEDULE_TYPE_USERS: User-based schedule - SCHEDULE_TYPE_SITES: Site-based schedule - SCHEDULE_TYPE_ASSETS: Asset-based schedule
    - `asset_ids` string[] — The assets assigned to this schedule item. It is empty if asset IDs are not used for assignment.
  - `total_records` integer — Total number of records.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)