v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Schedules

List schedule targets

Returns the sites or assets a schedule applies to, along with the recurrence for each. Results are filtered by the caller's access — only items the caller has permission to view are returned. total_count reflects the full number of sites or assets on the schedule and may exceed the number of items returned.

get/scheduling/v1/schedule_targets/{schedule_id}

Path parameters

schedule_idstring required

ID of the schedule (Required).

Query parameters

page_sizeinteger

Number of sites or assets per page (max 1000).

page_tokenstring

Token for fetching a specific page of results.

search_querystring

Text search query to filter results by site name or asset name. Case-insensitive. Does not affect total_count, which always reflects the full unfiltered count.

Response

A successful response.

total_countinteger

Total number of sites or assets the schedule applies to, regardless of the caller's access or any search_query filter. This value may exceed the number of items returned when the caller does not have permission to view all sites or assets, or when a search_query is set.

next_page_tokenstring

Token for fetching the next page. Token is empty when there are no more results.