Entrances

The acs_entrance Object

• Properties

• Events

• Endpoints

Represents an entrance within an access control system.

In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the acs_entrance resources in your workspace or get these details for a specific acs_entrance. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.

ACS Entrance

An access system entrance resource.

{
  "acs_entrance_id": "f74e4879-5991-4e2f-a368-888983dcfbfc",
  "acs_system_id": "6a74a969-94ea-4383-b5cf-5e7da8c113d1",
  "connected_account_id": "1b9a3e0d-443f-4063-b619-4ca7e2a97751",
  "created_at": "2025-06-15T16:54:17.946495Z",
  "display_name": "Main Entrance",
  "errors": [],
  "space_ids": [],
  "visionline_metadata": {
    "door_category": "guest",
    "door_name": "Main Entrance",
    "profiles": [
      {
        "visionline_door_profile_id": "7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a",
        "visionline_door_profile_type": "BLE"
      }
    ]
  }
}

---

Properties

acs_entrance_id UUID

ID of the entrance.

---

acs_system_id UUID

ID of the access control system that contains the entrance.

---

assa_abloy_vostio_metadata Object

ASSA ABLOY Vostio-specific metadata associated with the entrance.

Child Properties

• door_name String

  Name of the door in the Vostio access system.

• door_number Number

  Number of the door in the Vostio access system.

• door_type Enum

  Type of the door in the Vostio access system.

• pms_id String

  PMS ID of the door in the Vostio access system.

• stand_open Boolean

  Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.

---

can_belong_to_reservation Boolean

Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.

---

can_unlock_with_card Boolean

Indicates whether the ACS entrance can be unlocked with card credentials.

---

can_unlock_with_code Boolean

Indicates whether the ACS entrance can be unlocked with pin codes.

---

can_unlock_with_mobile_key Boolean

Indicates whether the ACS entrance can be unlocked with mobile key credentials.

---

connected_account_id UUID

ID of the connected account associated with the entrance.

---

created_at Datetime

Date and time at which the entrance was created.

---

display_name String

Display name for the entrance.

---

dormakaba_ambiance_metadata Object

dormakaba Ambiance-specific metadata associated with the entrance.

Child Properties

• access_point_name String

  Name of the access point in the dormakaba Ambiance access system.

---

dormakaba_community_metadata Object

dormakaba Community-specific metadata associated with the entrance.

Child Properties

• access_point_profile String

  Type of access point profile in the dormakaba Community access system.

---

errors List of Objects

Errors associated with the entrance.

Child Object Properties

error_code String

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

---

hotek_metadata Object

Hotek-specific metadata associated with the entrance.

Child Properties

• common_area_name String

  Display name of the entrance.

• common_area_number String

  Display name of the entrance.

• room_number String

  Room number of the entrance.

---

latch_metadata Object

Latch-specific metadata associated with the entrance.

Child Properties

• accessibility_type String

  Accessibility type in the Latch access system.

• door_name String

  Name of the door in the Latch access system.

• door_type String

  Type of the door in the Latch access system.

• is_connected Boolean

  Indicates whether the entrance is connected.

---

salto_ks_metadata Object

Salto KS-specific metadata associated with the entrance.

Child Properties

• battery_level String

  Battery level of the door access device.

• door_name String

  Name of the door in the Salto KS access system.

• intrusion_alarm Boolean

  Indicates whether an intrusion alarm is active on the door.

• left_open_alarm Boolean

  Indicates whether the door is left open.

• lock_type String

  Type of the lock in the Salto KS access system.

• locked_state String

  Locked state of the door in the Salto KS access system.

• online Boolean

  Indicates whether the door access device is online.

• privacy_mode Boolean

  Indicates whether privacy mode is enabled for the lock.

---

salto_space_metadata Object

Salto Space-specific metadata associated with the entrance.

Child Properties

• audit_on_keys Boolean

  Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.

• door_description String

  Description of the door in the Salto Space access system.

• door_id String

  Door ID in the Salto Space access system.

• door_name String

  Name of the door in the Salto Space access system.

• ext_door_id String

Deprecated. use door_id.

• room_description String

  Description of the room in the Salto Space access system.

• room_name String

  Name of the room in the Salto Space access system.

---

space_ids List of UUIDs

IDs of the spaces that the entrance is in.

---

visionline_metadata Object

Visionline-specific metadata associated with the entrance.

Child Properties

• door_category Enum

  Category of the door in the Visionline access system.

• door_name String

  Name of the door in the Visionline access system.

• profiles List of Objects

  Profile for the door in the Visionline access system.

• visionline_door_profile_id String

  Door profile ID in the Visionline access system.

• visionline_door_profile_type Enum

  Door profile type in the Visionline access system.

---

Events

acs_entrance.added

An access system entrance was added.

Properties

acs_entrance_id UUID

acs_system_id UUID

ID of the access system.

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: acs_entrance.added

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

acs_entrance.removed

An access system entrance was removed.

Properties

acs_entrance_id UUID

acs_system_id UUID

ID of the access system.

connected_account_id UUID

ID of the connected account.

created_at Datetime

Date and time at which the event was created.

event_id UUID

ID of the event.

event_type Enum

Value: acs_entrance.removed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

---

Endpoints

/acs/entrances/get

Returns a specified access system entrance.

/acs/entrances/grant_access

Grants a specified access system user access to a specified access system entrance.

/acs/entrances/list

Returns a list of all access system entrances.

/acs/entrances/list_credentials_with_access

Returns a list of all credentials with access to a specified entrance.