v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Data Feeds

Data feed for schedule assignees

get/scheduling/v1/feed/schedule_assignees

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.

show_activeboolean

Include assignees from active schedules. • true: Include assignees from active schedules • false: Exclude assignees from active schedules • default: true

show_finishedboolean

Include assignees from finished schedules. • true: Include assignees from finished schedules • false: Exclude assignees from finished schedules • default: true

show_pausedboolean

Include assignees from paused schedules. • true: Include assignees from paused schedules • false: Exclude assignees from paused schedules • default: true

templatestring[]

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

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.