List Credentials

Returns a list of all credentials.

POST /acs/credentials/list

JavaScript

Seam SDK

await seam.acs.credentials.list();

/*
[
  {
    "access_method": "code",
    "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
    "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
    "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
    "code": "123456",
    "created_at": "2025-06-16T16:54:17.946514Z",
    "display_name": "FRONT_DOOR",
    "errors": [],
    "external_type": "salto_ks_credential",
    "external_type_display_name": "Salto KS Credential",
    "is_latest_desired_state_synced_with_provider": true,
    "is_managed": true,
    "is_multi_phone_sync_credential": false,
    "is_one_time_use": false,
    "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z",
    "starts_at": "2025-07-10T16:54:17.946512Z",
    "warnings": [],
    "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd"
  }
]
*/

200

{
  "acs_credentials": [
    {
      "acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "errors": [
        {
          "error_code": "<string>",
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "error_code": "<string>",
          "message": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assa_abloy_vostio_metadata": {
        "auto_join": true,
        "door_names": [
          "<string>"
        ],
        "endpoint_id": "<string>",
        "key_id": "<string>",
        "key_issuing_request_id": "<string>",
        "override_guest_acs_entrance_ids": [
          "<string>"
        ]
      },
      "card_number": "<string>",
      "code": "<string>",
      "ends_at": "<string>",
      "external_type_display_name": "<string>",
      "is_issued": true,
      "is_latest_desired_state_synced_with_provider": true,
      "is_multi_phone_sync_credential": true,
      "is_one_time_use": true,
      "issued_at": "2023-11-07T05:31:56Z",
      "latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
      "parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "starts_at": "<string>",
      "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visionline_metadata": {
        "auto_join": true,
        "card_id": "<string>",
        "common_acs_entrance_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "credential_id": "<string>",
        "guest_acs_entrance_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "is_valid": true,
        "joiner_acs_credential_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    }
  ],
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

api_keyclient_sessionpat_with_workspaceconsole_session_with_workspace

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Option 1

Option 2

Option 3

Option 4

Option 5

acs_user_id · string<uuid> · required

ID of the access system user for which you want to retrieve all credentials.

created_before · string<date-time>

Date and time, in ISO 8601 format, before which events to return were created.

is_multi_phone_sync_credential · boolean

Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.

limit · number<float> · default: 500

Number of credentials to return.

page_cursor · string | null

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

search · string

String for which to search. Filters returned credentials to include all records that satisfy a partial match using display_name, code, card_number, acs_user_id or acs_credential_id.

Minimum string length: 1

Response

200

application/json

OK

acs_credentials · object[] · required

Show child attributes

ok · boolean · required

pagination · object · required

Information about the current page of results.

Show child attributes