v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB

Schedules (legacy)

List schedule items

get/schedules/v1/schedule_items

Query parameters

page_sizeinteger

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_tokenstring

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='

statusesstring[]

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

Response

A successful response.

next_page_tokenstring

If there might be more results than those appearing in this response, then next_page_token is included. If empty then there are no more results. To get the next set of results, call this method again using the value of next_page_token as page_token. For Example: 'MzA='

totalinteger

Total number of schedule items found

Example response

{
  "items": [
    {
      "start_time": {
        "hour": 15,
        "minute": 56
      },
      "reminders": [
        {
          "event": "START",
          "duration": "PT5M"
        }
      ],
      "assignees": [
        {
          "id": "0e7cff72-f919-4c84-aa37-e847b306423e",
          "type": "USER",
          "name": "Joe Bloggs"
        }
      ],
      "creator": {
        "id": "0e7cff72-f919-4c84-aa37-e847b306423e",
        "type": "USER",
        "name": "Joe Bloggs"
      },
      "document": {
        "id": "0e7cff72-f919-4c84-aa37-e847b306423e",
        "type": "TEMPLATE",
        "name": "Joe's JSA Template"
      }
    }
  ]
}