v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Data Feeds

Data feed for schedule occurrences

get/scheduling/v1/feed/schedule_occurrences

Query parameters

limitinteger

Maximum number of schedule occurrence records to scan (1-1000). • Default: 50 records • Maximum: 1000 records Please note that the number of records returned might be higher than the limit because a schedule occurrence might have multiple assignees.

templatestring[]

Filter occurrences by template IDs used to create the schedules. • Provide template IDs to only return occurrences from schedules using those templates. Omit to return occurrences from all templates. For example, ["template_xxx", "template_yyy"].

start_datestring date-time

Return occurrences due on or after this timestamp. • Use ISO 8601 format with timezone. For example, 2024-01-28T23:14:23.000Z. • Default: now - 5 months

end_datestring date-time

Return occurrences due on or before this timestamp. • Use ISO 8601 format with timezone For example, 2024-12-31T23:59:59.000Z. • Default: now + 1 month

next_page_tokenstring

Page token to retrieve next page. This token is returned in the metadata of previous responses when more data is available.

PAGINATION USAGE:

  • For the first page, omit next_page_token or provide an empty string.
  • For subsequent pages, use next_page_token from previous response metadata.

Response

A successful response.