BRbreezeway

Copy of List people

get/people/availability/{date}

Request

  • Base URL
    https://api.breezeway.io/public/inventory/v1
  • URL
    https://api.breezeway.io/public/inventory/v1/people/availability/{date}
  • Auth
    API key in header Authorization

Path parameters

datestring date required

ISO-8601 formatted date to look up

Query parameters

status'available' | 'unavailable' | 'any' | 'unset'
departmentstring

A department code such as 'maintenance' to filter users. Will include administrators as they have every department.

company_group_idsstring

A comma seperated list of IDs for company groups to filter to. Will include users who have access to all groups.

Response

200

availabilityboolean

True indicates at least partial availability for the day False indicates the day is configured as unavailable Null indicates a lack of configuration

display_namestring required
company_person_idinteger required

Example response

[
  {
    "availability": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.