Skip to main content

​
The space Object

Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
A space resource.
{
  "created_at": "2025-06-16T16:54:17.946600Z",
  "display_name": "My Space",
  "name": "My Space",
  "space_id": "5afeb047-3277-4102-b8c4-99edf05b91d2",
  "workspace_id": "96bd12f9-6def-4bf4-b517-760417451ae9"
}

​
Properties

acs_entrance_count Number Number of entrances in the space.
created_at Datetime Date and time at which the space was created.
customer_key String Customer key associated with the space.
device_count Number Number of devices in the space.
display_name String Display name for the space.
name String Name of the space.
space_id UUID ID of the space.
space_key String Unique key for the space within the workspace.
workspace_id UUID ID of the workspace associated with the space.

​
Events

space.device_membership_changed A device was added or removed from a space.
space.created A space was created.
space.deleted A space was deleted.

​
Endpoints

/spaces/add_acs_entrances Adds entrances to a specific space. /spaces/add_devices Adds devices to a specific space. /spaces/create Creates a new space. /spaces/delete Deletes a space. /spaces/get Gets a space. /spaces/get_related Gets all related resources for one or more Spaces. /spaces/list Returns a list of all spaces. /spaces/remove_acs_entrances Removes entrances from a specific space. /spaces/remove_devices Removes devices from a specific space. /spaces/update Updates an existing space.