List Entrances

Get all entrances

Returns a list of all entrances.

Request

To filter the list of returned entrances by a specific access control system or credential, include one or both of the acs_system_id or acs_credential_id parameters, respectively, in the request body. If you omit these parameters, the response includes all entrances in your workspace.

Request Body Parameters

ParameterTypeDescription

acs_system_id

String (UUID) Optional

ID of the access control system for which you want to retrieve all entrances

acs_credential_id

String (UUID) Optional

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

Sample Request

seam.acs.entrances.list(
  acs_system_id="11111111-1111-1111-1111-111111111111",
  acs_credential_id="66666666-6666-6666-6666-666666666666"
)

Response

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

PropertyDescription

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'
  ),
  ...
]

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.