List Accessible Entrances

Get all entrances to which a specified credential grants access

Returns a list of all entrances to which a credential grants access.

/acs/credentials/list_accessible_entrances

post

Returns a list of all entrances to which a credential grants access.

Authorizations

api_keypat_with_workspaceconsole_session_with_workspace

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

acs_credential_idstring · uuidRequired

ID of the credential for which you want to retrieve all entrances to which the credential grants access.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

/acs/credentials/list_accessible_entrances

HTTPcURLJavaScriptPython

POST /acs/credentials/list_accessible_entrances HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "acs_entrances": [
    {
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
      "space_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "created_at": "2026-01-30T22:36:01.326Z",
      "display_name": "text",
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "errors": [
        {
          "error_code": "text",
          "message": "text"
        }
      ],
      "latch_metadata": {
        "accessibility_type": "text",
        "door_name": "text",
        "door_type": "text",
        "is_connected": true
      },
      "hotek_metadata": {
        "room_number": "text",
        "common_area_number": "text",
        "common_area_name": "text"
      },
      "visionline_metadata": {
        "door_name": "text",
        "door_category": "entrance",
        "profiles": [
          {
            "visionline_door_profile_id": "text",
            "visionline_door_profile_type": "BLE"
          }
        ]
      },
      "salto_ks_metadata": {
        "door_name": "text",
        "locked_state": "text",
        "lock_type": "text",
        "online": true,
        "battery_level": "text",
        "left_open_alarm": true,
        "intrusion_alarm": true,
        "privacy_mode": true
      },
      "dormakaba_community_metadata": {
        "access_point_profile": "text"
      },
      "assa_abloy_vostio_metadata": {
        "door_type": "CommonDoor",
        "door_name": "text",
        "door_number": 1,
        "stand_open": true,
        "pms_id": "text"
      },
      "salto_space_metadata": {
        "door_id": "text",
        "door_name": "text",
        "door_description": "text",
        "audit_on_keys": true,
        "room_name": "text",
        "room_description": "text"
      },
      "dormakaba_ambiance_metadata": {
        "access_point_name": "text"
      },
      "can_unlock_with_mobile_key": true,
      "can_unlock_with_card": true,
      "can_unlock_with_code": true,
      "can_belong_to_reservation": true
    }
  ],
  "ok": true
}

Request

Specify the credential for which you want to retrieve all accessible entrances by including the corresponding acs_credential_id in the request body.

Request Body Parameters

Parameter	Type	Description
acs_credential_id	String (UUID) Required	ID of the credential for which you want to retrieve all entrances to which this credential grants access

Sample Request

Python

seam.acs.credentials.list_accessible_entrances(
  acs_credential_id="66666666-6666-6666-6666-666666666666"
)

cURL (bash)

JavaScript

Ruby

PHP

C#

Java

Go

Response

Returns an acs_entrances array, in which each returned acs_entrance contains the following properties:

Property	Description
acs_entrance_id	ID of the entrance
acs_system_id	ID of the access control system that contains the entrance
workspace_id	ID of the workspace that contains the user
display_name	Display name for the entrance
XXX_metadata	ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer
created_at	Date and time at which the entrance was created

Sample Response

This response contains manufacturer-specific metadata that may vary by manufacturer.

Python

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    visionline_metadata=
      profiles=[
        {
          'visionline_door_profile_id': 'Guest Door',
          'visionline_door_profile_type': 'BLE'
        }
      ],
      door_name='Guest Lock 2',
      door_category='guest'
    },
    latch_metadata=null,
    display_name='Guest Lock 2',
    created_at='2024-03-26T14:31:18.979Z'
  ),
  ...
]

cURL (bash)

JavaScript

Ruby

PHP

C#

Java

Go