API

Data feed for schedule occurrences

📘️ Important update

Starting February 1, 2025, we will standardize the date and time format in Feed APIs.

  • New format: {year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z

  • Example: 2014-01-28T23:14:23.000Z

Until this change is implemented, you can continue to use the current format. After this date, API requests with incorrect formats will return an error. We would recommend that you update your applications to the new format as soon as possible.
Learn more

When returning data from the schedule_occurrences feed, the start_date and end_date apply to the due_time field of each occurrence.

This means that even if an occurrence was started and completed within the specified time range, it may not appear in the results.

Example of data returned from occurrences API, with start_data and end_date parameters

In this example monthly_2 -> monthly_7 and quarterly_1 -> quarterly_2 are returned from the API as their due_time fall within the state_date and end_date.

Language
Authorization
Bearer
Click Try It! to start a request and see the response here!