Spaces
Early Access Preview. The spaces API is currently in Alpha. We're actively developing it and seeking early feedback at [email protected]. Expect breaking changes as we refine the design.
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.
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.
Properties
acs_entrance_ids List of UUIDs
IDs of all ACS entrances currently attached to the space.
created_at Datetime
Date and time at which the event was created.
device_ids List of UUIDs
IDs of all devices currently attached to the space.
event_id UUID
ID of the event.
event_type Enum
Type of the event.
Value: space.device_membership_changed
occurred_at Datetime
Date and time at which the event occurred.
space_id UUID
ID of the affected space.
space_key String
Unique key for the space within the workspace.
workspace_id UUID
ID of the workspace associated with the event.
space.created
A space was created.
Properties
acs_entrance_ids List of UUIDs
IDs of all ACS entrances attached to the space when it was created.
created_at Datetime
Date and time at which the event was created.
device_ids List of UUIDs
IDs of all devices attached to the space when it was created.
event_id UUID
ID of the event.
event_type Enum
Type of the event.
Value: space.created
occurred_at Datetime
Date and time at which the event occurred.
space_id UUID
ID of the affected space.
space_key String
Unique key for the space within the workspace.
workspace_id UUID
ID of the workspace associated with the event.
space.deleted
A space was deleted.
Properties
acs_entrance_ids List of UUIDs
IDs of all ACS entrances currently attached to the space when it was deleted.
created_at Datetime
Date and time at which the event was created.
device_ids List of UUIDs
IDs of all devices attached to the space when it was deleted.
event_id UUID
ID of the event.
event_type Enum
Type of the event.
Value: space.deleted
occurred_at Datetime
Date and time at which the event occurred.
space_id UUID
ID of the affected space.
space_key String
Unique key for the space within the workspace.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
Adds entrances to a specific space.
Adds devices to a specific space.
Creates a new space.
Deletes a space.
Gets a space.
Gets all related resources for one or more Spaces.
Returns a list of all spaces.
Removes entrances from a specific space.
Removes devices from a specific space.
Updates an existing space.
Last updated
Was this helpful?