Sign UpSupported Devices
Edit

Get an Entrance

Get a specified entrance

Returns a specified entrance.

/acs/entrances/get

post

Returns a specified access system entrance.

Authorizations
Body
acs_entrance_idstring · uuidRequired

ID of the entrance that you want to get.

Responses
200

OK

application/json
post
/acs/entrances/get
POST /acs/entrances/get HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "acs_entrance": {
    "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": "2025-11-03T14:10:11.303Z",
    "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",
      "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 desired entrance by including the corresponding acs_entrance_id in the request body.

Request Body Parameters

Parameter
Type
Description

acs_entrance_id

String (UUID) Required

ID of the desired entrance

Sample Request

seam.acs.entrances.get(
  acs_entrance_id="55555555-5555-5555-5555-555555555555"
)

Response

Returns an acs_entrance containing 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.

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'
)
PreviousList EntrancesNextList Credentials with Access to an Entrance

Last updated

Was this helpful?