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.

/acs/entrances/list_credentials_with_access

POSThttps://connect.getseam.com/acs/entrances/list_credentials_with_access

Authorization

Body

acs_entrance_id*string (uuid)

include_ifarray of enum

Response

Body

acs_credentials*array of acs_credential (object)

ok*boolean

Request

const response = await fetch('https://connect.getseam.com/acs/entrances/list_credentials_with_access', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "acs_credentials": [
    {
      "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
      "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "display_name": "text",
      "code": "text",
      "access_method": "code",
      "external_type": "pti_card",
      "external_type_display_name": "text",
      "created_at": "2024-09-10T04:24:31.595Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "starts_at": "text",
      "ends_at": "text",
      "errors": [
        {
          "error_code": "text",
          "message": "text"
        }
      ],
      "warnings": [
        {
          "warning_code": "text",
          "message": "text"
        }
      ],
      "is_multi_phone_sync_credential": false,
      "is_latest_desired_state_synced_with_provider": false,
      "latest_desired_state_synced_with_provider_at": "2024-09-10T04:24:31.595Z",
      "visionline_metadata": {
        "card_function_type": "guest",
        "joiner_acs_credential_ids": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "guest_acs_entrance_ids": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "common_acs_entrance_ids": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "is_valid": false,
        "card_id": "text",
        "credential_id": "text"
      },
      "is_managed": true
    }
  ],
  "ok": false
}

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

Parameter Type Description

Parameter	Type	Description
`acs_entrance_id`	String (UUID) Required	ID of the entrance for which you want to retrieve all credentials with access

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"
)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/entrances/list_credentials_with_access' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555"
}'

await seam.acs.entrances.list_credentials_with_access({
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
});

# Coming soon!

$seam->acs->entrances->list_credentials_with_access(
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
);

seam.EntrancesAcs.ListCredentialsWithAccess(
  acsEntranceId: "55555555-5555-5555-5555-555555555555"
);

// Coming soon!

acs_users, uErr := client.Acs.Entrances.ListCredentialsWithAccess(
  context.Background(), &acs.UsersListRequest{
    AcsEntranceId: api.String("55555555-5555-5555-5555-555555555555")
  },
)

Response

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

Property Description

Property	Description
`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

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={}
  ),
  ...
]

{
  "acs_credentials": [
    {
      "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": {}
    },
    ...
  ],
  "ok": true
}

[
  {
    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: {}
  },
  ...
]

# Coming Soon!

[
  {
    "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": {}
  },
  ...
]

{
  "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": {}
}
...

// Coming soon!

{
  "acs_credentials": [
    {
      "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": {}
    },
    ...
  ],
  "ok": true
}

PreviousGet an Entrance NextAccess Groups

Last updated 2 months ago