List Credentials

Get all credentials

Returns a list of all credentials.

/acs/credentials/list

post

Returns a list of all credentials.

Authorizations

api_keyclient_sessionpat_with_workspaceconsole_session_with_workspace

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

all ofOptional

one ofOptional

or

or

or

or

objectOptional

and

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

/acs/credentials/list

HTTPcURLJavaScriptPython

POST /acs/credentials/list HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "limit": 500,
  "created_before": "2025-11-26T10:01:11.697Z",
  "is_multi_phone_sync_credential": true,
  "search": "text",
  "page_cursor": "text"
}

{
  "acs_credentials": [
    {
      "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
      "connected_account_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",
      "is_one_time_use": true,
      "card_number": "text",
      "is_issued": true,
      "issued_at": "2025-11-26T10:01:11.697Z",
      "access_method": "code",
      "external_type": "pti_card",
      "external_type_display_name": "text",
      "created_at": "2025-11-26T10:01:11.697Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "starts_at": "text",
      "ends_at": "text",
      "errors": [
        {
          "error_code": "text",
          "message": "text"
        }
      ],
      "warnings": [
        {
          "created_at": "2025-11-26T10:01:11.697Z",
          "message": "text",
          "warning_code": "waiting_to_be_issued"
        }
      ],
      "is_multi_phone_sync_credential": true,
      "is_latest_desired_state_synced_with_provider": true,
      "latest_desired_state_synced_with_provider_at": "2025-11-26T10:01:11.697Z",
      "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": true,
        "auto_join": true,
        "card_id": "text",
        "credential_id": "text"
      },
      "assa_abloy_vostio_metadata": {
        "auto_join": true,
        "override_guest_acs_entrance_ids": [
          "text"
        ],
        "key_id": "text",
        "key_issuing_request_id": "text",
        "door_names": [
          "text"
        ],
        "endpoint_id": "text"
      },
      "is_managed": true
    }
  ],
  "pagination": {
    "next_page_cursor": "text",
    "has_next_page": true,
    "next_page_url": "https://example.com"
  },
  "ok": true
}

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)

JavaScript

Ruby

PHP

C#

Java

Go

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)

JavaScript

Ruby

PHP

C#

Java

Go