Guides

Retrieve Information about your organization's spaces.

Authorization

This endpoint requires Authorization.

Response

Returns Paginated data of the following format for each item:

KeySubkeyTypeDescription
idIntegerUnique identifier for the space.
nameStringName of the space.
parent_idIntegerUnique identifier for the parent space.
configObjectConfiguration settings for the space.
imgStringURL of an image associated with the space.
locationObjectLocation information for the space. See Location table.
priority_factorIntegerPriority factor for events related to the space.-1: High Priority, 0: No Change, 1: Low Priority
inherit_locationBooleanFlag indicating whether location should be inherited from the parent space.
temperature_ unitsStringUnits for temperature measurement. Celsius, Fahrenheit
inherit_priority_factorBooleanFlag indicating whether priority factor should be inherited from the parent space.
inherit_temperature_unitsBooleanFlag indicating whether temperature units should be inherited from the parent space.

Location

KeySubkeyTypeDescription
locationObjectGeospatial coordinates of the space.
latFloatLatitude coordinate of the space.
lngFloatLongitude coordinate of the space.
utc_offsetIntegerUTC offset in minutes.
descriptionStringDescription of the location.
region_ nameStringIANA Time Zone database region name.
Language
Authorization
Header
Click Try It! to start a request and see the response here!