COconnecteam
Schedule:v1:Schedulers:Schedule:Schedule Unavailabilities

Get schedule unavailabilities

Retrieve a list of unavailabilities under a specific schedule filtered by date range. The response is paginated and can be filtered by user ID.

get/scheduler/v1/schedulers/{schedulerId}/unavailabilities

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/scheduler/v1/schedulers/{schedulerId}/unavailabilities
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: schedule.read

Path parameters

schedulerIdinteger required

The unique identifier of the schedule

Query parameters

startTimeinteger required

The start time to filter by in Unix format (in seconds)

endTimeinteger required

The end time to filter by in Unix format (in seconds)

limitinteger

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Response

Successful Response

requestIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.