# Entrances

## The acs\_entrance Object

* [Properties](#properties)
* [Errors](#errors)
* [Warnings](#warnings)
* [Events](#events)
* [Endpoints](#endpoints)

Represents an [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).

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.

{% tabs %}
{% tab title="JSON" %}

```json
{
  acs_entrance_id: [example value],
  acs_system_id: [example value],
  assa_abloy_vostio_metadata: [example value],
  created_at: [example value],
  display_name: [example value],
  dormakaba_community_metadata: [example value],
  errors: [example value],
  latch_metadata: [example value],
  salto_ks_metadata: [example value],
  salto_space_metadata: [example value],
  visionline_metadata: [example value]
}
```

{% endtab %}
{% endtabs %}

***

## Properties

**`acs_entrance_id`** *UUID*

ID of the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

***

**`acs_system_id`** *UUID*

ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

***

**`assa_abloy_vostio_metadata`** *Object*

ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Properties</summary>

* **`door_name`** *String*
* **`door_number`** *Number*
* **`door_type`** *Enum*
* **`pms_id`** *String*
* **`stand_open`** *Boolean*

</details>

***

**`created_at`** *Datetime*

Date and time at which the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details) was created.

***

**`display_name`** *String*

Display name for the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

***

**`dormakaba_community_metadata`** *Object*

dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Properties</summary>

* **`access_point_name`** *String*

</details>

***

**`errors`** *List* *of Objects*

Errors associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Object Properties</summary>

**`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.
```

</details>

***

**`latch_metadata`** *Object*

Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Properties</summary>

* **`accessibility_type`** *String*
* **`door_name`** *String*
* **`door_type`** *String*
* **`is_connected`** *Boolean*

</details>

***

**`salto_ks_metadata`** *Object*

Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Properties</summary>

* **`battery_level`** *String*
* **`door_name`** *String*
* **`intrusion_alarm`** *Boolean*
* **`left_open_alarm`** *Boolean*
* **`lock_type`** *String*
* **`locked_state`** *String*
* **`online`** *Boolean*
* **`privacy_mode`** *Boolean*

</details>

***

**`salto_space_metadata`** *Object*

Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Properties</summary>

* **`door_description`** *String*
* **`door_name`** *String*
* **`ext_door_id`** *String*

</details>

***

**`visionline_metadata`** *Object*

Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

<details>

<summary>Child Properties</summary>

* **`door_category`** *Enum*
* **`door_name`** *String*
* **`profiles`** *List* *of Objects*
* **`visionline_door_profile_id`** *String*
* **`visionline_door_profile_type`** *Enum*

</details>

***

## Events

**`acs_entrance.added`**

An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.

<details>

<summary>Properties</summary>

**`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.

</details>

***

**`acs_entrance.removed`**

An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.

<details>

<summary>Properties</summary>

**`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.

</details>

***

## Endpoints

[**`/acs/entrances/get`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/entrances/get)

Returns a specified [access system entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

[**`/acs/entrances/grant_access`**](https://github.com/seamapi/docs/blob/main/docs/api/acs/entrances/grant_access.md)

Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

[**`/acs/entrances/list`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/entrances/list)

Returns a list of all [access system entrances](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).

[**`/acs/entrances/list_credentials_with_access`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/entrances/list_credentials_with_access)

Returns a list of all [credentials](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details).