List Credentials with Access to an Entrance

Get all credentials with access to a specified entrance

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

Request

Specify the entrance for which you want to retrieve all credentials with access by including the corresponding acs_entrance_id in the request body.

You can also use a manufacturer-specific filter for entrances in a Visionline ACS. For details, see List All Valid Credentials for a Set of Guest Entrances to Add as Joiners.

Request Body Parameters

ParameterTypeDescription

acs_entrance_id

String (UUID) Required

ID of the entrance for which you want to retrieve all credentials with access

Sample Request

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

Response

Returns an acs_credentials array, in which each returned credential (acs_credential) contains the following properties:

PropertyDescription

acs_credential_id

ID of the credential

acs_user_id

ID of the user to whom the credential belongs

parent_acs_credential_id

ID of the parent ACS credential

display_name

Display name that corresponds to the credential type

code

Access (PIN) code for the credential

acs_system_id

ID of the access control system that contains the credential

access_method

Access method for the credential. Supported values: code, card, mobile_key

external_type

Brand-specific terminology for the credential type Supported values: pti_card, brivo_credential, hid_credential, visionline_card

external_type_display_name

Display name that corresponds to the brand-specific terminology for the credential type

workspace_id

ID of the workspace that contains the credential

created_at

Date and time at which the credential was created

starts_at

Date and time at which the credential validity starts, in ISO 8601 format

ends_at

Date and time at which the credential validity ends, in ISO 8601 format

is_multi_phone_sync_credential

Indicates whether the credential is a multi-phone sync credential

XXX_metadata

ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer

Sample Response

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

[
  AcsCredential(
    acs_credential_id='77777777-7777-7777-7777-777777777777',
    acs_user_id='33333333-3333-3333-3333-333333333333',
    parent_acs_credential_id='66666666-6666-6666-6666-666666666666',
    display_name='Credential 2',
    code=null,
    acs_system_id='11111111-1111-1111-1111-111111111111',
    access_method='mobile_key',
    external_type='visionline_card',
    external_type_display_name='Visionline Card',
    errors=[],
    warnings=[],
    workspace_id='00000000-0000-0000-0000-000000000000',
    created_at='2024-04-09T14:30:56.343Z',
    starts_at='2024-04-09T14:30:55.688Z',
    ends_at='2024-03-04T10:40:00.000Z',
    is_multi_phone_sync_credential=False,
    visionline_metadata={}
  ),
  ...
]

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.