List schedule items

get

https://api.safetyculture.io/schedules/v1/schedule_items

📘
New Schedules endpoints are now available
Schedules legacy endpoints will continue to be supported. Any deprecation will be communicated with a minimum 6-month notice. See Schedules to get started.

The schedule items list endpoint allows you to retrieve all of the schedule items that meet a certain criteria. It is possible to filter schedule items based on their current status. The presence of next_page_token indicates that there are more results for this listing. It is possible to provide the number of schedule items that will be returned using the optional parameter page_size. It accepts non-negative numbers with a default and maximum value of 100.

Query Params

page_size

int32

Number of messages to be returned in a single request. Maximum
100. Non-positive values are ignored. The presence of next_page_token in
the response indicates that more results might be available. For example:
'20'

page_token

string

If present, then retrieve the next batch of results from the
preceding call to this method. page_token must be the value of
next_page_token from the previous response. The values of other method
parameters should be identical to those in the previous call.
For example: 'MzA='

statuses

array of strings

Filter ScheduleItems to those with one of the the given status

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

statuses

Responses

New Schedules endpoints are now available

200A successful response.

defaultAn unexpected error response.