---
title: "List schedule items"
method: GET
path: "/schedules/v1/schedule_items"
tags: ["Schedules (legacy)"]
---

# List schedule items

`GET /schedules/v1/schedule_items`

## Query parameters

- `page_size` integer
- `page_token` string
- `statuses` string[]

## Response `200`

A successful response.

- S12SchedulesV1ListScheduleItemsResponse — Result returned from `ListScheduleItems`
  - `items` S12SchedulesV1ScheduleItem[] — A list of schedule items
    - `id` string — ID of the schedule item
    - `description` string — Description of the schedule item
    - `must_complete` 'MUST_COMPLETE_UNSPECIFIED' | 'ONE' | 'ALL' — - MUST_COMPLETE_UNSPECIFIED: Unspecified must complete value - ONE: Schedule must be completed by one assignee - ALL: Schedule must be completed by all assignees
    - `can_late_submit` boolean — Can the inspections be started after the due date
    - `recurrence` string — [RRule](https://www.textmagic.com/free-tools/rrule-generator) formatted recurrence string. <br> Example: `FREQ=WEEKLY;BYDAY=MO;INTERVAL=1` represents weekly on Monday.
    - `start_time` S12SchedulesV1ScheduleItemStartTime — StartTime represents the start time of a schedule item
      - `hour` integer, required — The hour of the day to start the schedule
      - `minute` integer, required — The minute of the day to start the schedule
    - `duration` string — ISO8601 duration string, e.g. PT1H. How long inspection can be started after the start_date.
    - `timezone` string — Timezone the schedule item will appear in
    - `from_date` string, date-time — When this schedule will begin appearing
    - `to_date` string, date-time — When the schedule will end
    - `reminders` S12SchedulesV1ScheduleItemReminder[] — Reminders that will be sent to assignees
      - `event` 'REMINDER_EVENT_TYPE_UNSPECIFIED' | 'START' | 'DUE', required — - REMINDER_EVENT_TYPE_UNSPECIFIED: Unspecified reminder event type - START: Default value - start of the schedule - DUE: End of the schedule
      - `duration` string, required — ISO8601 duration string, e.g. PT1H. How long before the event to remind the assignees.
    - `modified_at` string, date-time — When the schedule item was last modified
    - `created_at` string, date-time — When the schedule item was created
    - `status` 'STATUS_UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'NO_TEMPLATE' | 'NO_ASSIGNEE' | 'FINISHED' | 'SUBSCRIPTION_INACTIVE' | 'NO_SITE' — - STATUS_UNSPECIFIED: Unspecified status value - ACTIVE: Default value - schedule item is still active - PAUSED: Schedule has been paused e.g. manually paused/org frozen - NO_TEMPLATE: The template used for this schedule item has been deleted/archived - NO_ASSIGNEE: No valid assignees exist for this schedule item anymore - FINISHED: The schedule item has hit its end date or count limit and is now complete - SUBSCRIPTION_INACTIVE: User/org subscription is inactive - NO_SITE: The site used for this schedule has been removed
    - `assignees` S12SchedulesV1ScheduleItemEntity[] — The users or groups that are assigned to complete the schedule
      - `id` string, required — The unique identifier for the entity
      - `type` 'ENTITY_TYPE_UNSPECIFIED' | 'USER' | 'ROLE', required — - ENTITY_TYPE_UNSPECIFIED: Unspecified entity type - USER: User - ROLE: Role
      - `name` string — The name of the entity
    - `creator` S12SchedulesV1ScheduleItemEntity — Entity represent the entity in a schedule, either creator or assignee
      - `id` string, required — The unique identifier for the entity
      - `type` 'ENTITY_TYPE_UNSPECIFIED' | 'USER' | 'ROLE', required — - ENTITY_TYPE_UNSPECIFIED: Unspecified entity type - USER: User - ROLE: Role
      - `name` string — The name of the entity
    - `document` S12SchedulesV1ScheduleItemDocument — Document represents the document in a schedule
      - `id` string, required — The unique identifier for the document
      - `type` 'DOCUMENT_TYPE_UNSPECIFIED' | 'TEMPLATE', required — - DOCUMENT_TYPE_UNSPECIFIED: Unspecified document type - TEMPLATE: Inspection Template
      - `name` string — The name of the document
    - `location_id` string — The location assigned to this schedule item
    - `next_occurrence` S12SchedulesV1ScheduleItemNextOccurrence — NextOccurrence is the next time the schedule item will occur for assignees
      - `start` string, date-time — The timestamp in the Internet Date-Time format when the next occurrence will occur
      - `due` string, date-time — The timestamp in the Internet Date-Time format when the next occurrence is due by
    - `site_based_assignment_enabled` boolean — Allows for site based assignments when enabled.
    - `asset_id` string — The asset assigned to this schedule item
    - `migration_status` 'MIGRATION_STATUS_UNSPECIFIED' | 'MIGRATION_STATUS_MIGRATED' | 'MIGRATION_STATUS_STARTED' — MigrationStatus represents the legacy to new self-service migration state of a schedule item. - MIGRATION_STATUS_UNSPECIFIED: Default value; item has not been through migration. - MIGRATION_STATUS_MIGRATED: Item was successfully migrated to new scheduling. - MIGRATION_STATUS_STARTED: Item is being migrated: paused in legacy but new schedule has not been created yet.
  - `next_page_token` string — If there might be more results than those appearing in this response, then `next_page_token` is included. If empty then there are no more results. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. For Example: 'MzA='
  - `total` integer — Total number of schedule items found

## 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)