v1

latestOpenAPI 3.0.02026-07-2653703.5 MB
orgs/schedules

Describe a schedule

By default this endpoint joins the schedule with the shared zones that use it. These operations can be expensive. This data is not needed for most uses. Use an options value of withoutZoneUsers,withoutZoneGroups where possible for better performance. The caller can also specify one option without the other option if required. The syntax is as such: /orgs/{orgId}/schedules/{scheduleId}?options=withoutZoneUsers,withoutZoneGroups.<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r<br/><br/>Endpoint name: describeSchedule

get/orgs/{orgId}/schedules/{scheduleId}

Path parameters

orgIdinteger required
scheduleIdinteger required

Query parameters

optionsstring

Response

Successful