{
  "opencollection": "1.0.0",
  "info": {
    "name": "Openpath API Documentation auth orgs/schedules API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "orgs/schedules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/schedules",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "preFilter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "__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}-user:w,o{params.orgId}-user:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listSchedules"
        },
        {
          "info": {
            "name": "Create a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/orgs/:orgId/schedules",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-user:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w<br/><br/>__Endpoint name__: createSchedule"
        },
        {
          "info": {
            "name": "Describe a schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "options",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "By default this endpoint joins the schedule with the shared zones that use it. These operations can be expensive.\nThis data is not needed for most uses. Use an `options` value of `withoutZoneUsers,withoutZoneGroups` where possible for better performance.\nThe caller can also specify one option without the other option if required. The syntax is as such:\n`/orgs/{orgId}/schedules/{scheduleId}?options=withoutZoneUsers,withoutZoneGroups`.<br/><br/>__JWT is required for this endpoint with at least one"
        },
        {
          "info": {
            "name": "Update a schedule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateSchedule"
        },
        {
          "info": {
            "name": "Delete a schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteSchedule"
        },
        {
          "info": {
            "name": "Determine whether the API caller has access to modify this schedule via their admin permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/determineAccess",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: determineScheduleAccess"
        },
        {
          "info": {
            "name": "List all schedule events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/events",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "preFilter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "__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__: listEvents"
        },
        {
          "info": {
            "name": "Create a schedule event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/events",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: createEvent"
        },
        {
          "info": {
            "name": "Bulk update schedule events",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/events",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateEvents"
        },
        {
          "info": {
            "name": "Describe a schedule event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/events/:eventId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "eventId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__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__: describeEvent"
        },
        {
          "info": {
            "name": "Update a schedule event",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/events/:eventId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "eventId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateEvent"
        },
        {
          "info": {
            "name": "Delete a schedule event",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/orgs/:orgId/schedules/:scheduleId/events/:eventId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "eventId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-user:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteEvent"
        }
      ]
    }
  ],
  "bundled": true
}