List Credentials

Get all credentials

Returns a list of all credentials.

/acs/credentials/list

POSThttps://connect.getseam.com/acs/credentials/list

Authorization

api_keyclient_sessionpat_with_workspaceconsole_session

Body

application/json

one of

objectobjectobjectobject

limitnumber (float)

created_beforestring (date-time)

is_multi_phone_sync_credentialboolean

Response

200400401

OK

Body

application/json

acs_credentials*array of acs_credential (object)

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/acs/credentials/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200

{
  "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-10T05:23:08.482Z",
      "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-10T05:23:08.482Z",
      "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

Filter the list of returned credentials by ACS user, access control system, or user identity by including one or more of the acs_user_id, acs_system_id, or user_identity_id parameters, respectively, in the request body. You can also include the is_multi_phone_sync_credential parameter.

Request Body Parameters

Parameter	Type	Description
acs_user_id	String (UUID) Optional	ID of the user for which you want to retrieve all credentials
acs_system_id	String (UUID) Optional	ID of the access control system for which you want to retrieve all credentials
user_identity_id	String (UUID) Optional	ID of the user identity for which you want to retrieve all credentials
is_multi_phone_sync_credential	Boolean Optional	Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials

Sample Request

Python

seam.acs.credentials.list(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  acs_system_id="11111111-1111-1111-1111-111111111111",
  user_identity_id="22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential=True
)

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/credentials/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "user_identity_id": "22222222-2222-2222-2222-222222222222",
  "is_multi_phone_sync_credential": true
}'

JavaScript

await seam.acs.credentials.list({
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential: true
});

Ruby

# Coming soon!

PHP

$seam->acs->credentials->list(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential: true
);

C#

seam.CredentialsAcs.List(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  acsSystemId: "11111111-1111-1111-1111-111111111111",
  userIdentityId: "22222222-2222-2222-2222-222222222222",
  is_multi_phone_sync_credential: true
);

Java

// Coming soon!

Go

acs_credentials, uErr := client.Acs.Credentials.List(
  context.Background(), &acs.CredentialsListRequest{
    AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
    UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
    IsMultiPhoneSyncCredential: api.Bool(true),
  },
)

Response

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

Property	Description
acs_credential_id	ID of the credential
acs_user_id	ID of the user to whom the credential belongs
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
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
is_multi_phone_sync_credential	Indicates whether the credential is a multi-phone sync credential
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
XXX_metadata	ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer

Sample Response

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

Python

[
  AcsCredential(
    acs_credential_id='99999999-9999-9999-9999-999999999999',
    acs_user_id='33333333-3333-3333-3333-333333333333',
    display_name='Multi Phone Sync Credential',
    code=null,
    acs_system_id='11111111-1111-1111-1111-111111111111',
    access_method='mobile_key',
    workspace_id='00000000-0000-0000-0000-000000000000',
    created_at='2024-04-12T03:56:22.396Z',
    is_multi_phone_sync_credential=True,
    # manufacturer-specific metadata
  ),
  ...
]

cURL (bash)

{
  "acs_credentials": [
    {
      "acs_credential_id": "99999999-9999-9999-9999-999999999999",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Multi Phone Sync Credential",
      "code": null,
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "access_method": "mobile_key",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-04-12T03:56:22.396Z",
      "is_multi_phone_sync_credential": true,
      # manufacturer-specific metadata
    }
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    acs_credential_id: '99999999-9999-9999-9999-999999999999',
    acs_user_id: '33333333-3333-3333-3333-333333333333',
    display_name: 'Multi Phone Sync Credential',
    code: null,
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    access_method: 'mobile_key',
    workspace_id: '00000000-0000-0000-0000-000000000000',
    created_at: '2024-04-12T03:56:22.396Z',
    is_multi_phone_sync_credential: true,
    // manufacturer-specific metadata
  },
  ...
]

Ruby

# Coming soon!

PHP

[
  {
    "acs_credential_id": "99999999-9999-9999-9999-999999999999",
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Multi Phone Sync Credential",
    "code": null,
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "access_method": "mobile_key",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-04-12T03:56:22.396Z",
    "is_multi_phone_sync_credential": true,
    // manufacturer-specific metadata
  },
  ...
]

C#

{
  "acs_credential_id": "99999999-9999-9999-9999-999999999999",
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "display_name": "Multi Phone Sync Credential",
  "code": null,
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "access_method": "mobile_key",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-04-12T03:56:22.396Z",
  "is_multi_phone_sync_credential": true,
  // manufacturer-specific metadata
}
...

Java

// Coming soon!

Go

{
  "acs_credentials": [
    {
      "acs_credential_id": "99999999-9999-9999-9999-999999999999",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Multi Phone Sync Credential",
      "code": null,
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "access_method": "mobile_key",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-04-12T03:56:22.396Z",
      "is_multi_phone_sync_credential": true,
      # manufacturer-specific metadata
    }
    ...
  ],
  "ok": true
}