UNunified
calendar
room

Retrieve a room

Changed on

Retrieves a single CalendarRoom by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/calendar/{connection_id}/room/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Room

Query parameters

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