UNunified
calendar
room

List all rooms

Changed on

Returns a list of CalendarRooms. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/calendar/{connection_id}/room

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/calendar/{connection_id}/room
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

location_idstring

The location ID to filter by

typestring

The room type to filter by (ROOM, DESK or OTHER)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
type'ROOM' | 'DESK' | 'OTHER'
capacitynumber
location_idstring
descriptionstring
emailstring

the room's calendar/mailbox address, used to invite the room to an event

rawobject
calendar_idstring

(reference to CalendarCalendar)

floorstring
timezonestring
web_urlstring
is_activeboolean
is_bookableboolean
featuresstring[]

e.g. projector, whiteboard, video conferencing

Changes