List Access Codes

Returns a list of all access codes.

Specify device_id, access_code_ids, access_method_id, or access_grant_id.

POST /access_codes/list

JavaScript

Seam SDK

await seam.accessCodes.list({
  device_id: "f5197f50-839b-4a8e-82f3-e9ef06af93ae",
  limit: 10,
});

/*
[
  {
    "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
    "code": "1234",
    "common_code_key": null,
    "created_at": "2025-06-14T16:54:17.946242Z",
    "device_id": "f5197f50-839b-4a8e-82f3-e9ef06af93ae",
    "ends_at": "2025-07-04T16:54:17.946049Z",
    "errors": [],
    "is_backup": false,
    "is_backup_access_code_available": false,
    "is_external_modification_allowed": false,
    "is_managed": true,
    "is_offline_access_code": false,
    "is_one_time_use": false,
    "is_scheduled_on_device": true,
    "is_waiting_for_code_assignment": false,
    "name": "My Access Code",
    "pulled_backup_access_code_id": null,
    "starts_at": "2025-07-02T16:54:17.946049Z",
    "status": "set",
    "type": "time_bound",
    "warnings": [],
    "workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
  }
]
*/

200

{
  "access_codes": [
    {
      "access_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "common_code_key": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "errors": [
        {
          "error_code": "<string>",
          "message": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "is_backup_access_code_available": true,
      "is_external_modification_allowed": true,
      "is_offline_access_code": true,
      "is_one_time_use": true,
      "name": "<string>",
      "pending_mutations": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>"
        }
      ],
      "warnings": [
        {
          "error_code": "<string>",
          "message": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dormakaba_oracode_metadata": {
        "stay_id": 123,
        "user_level_name": "<string>",
        "is_cancellable": true,
        "is_early_checkin_able": true,
        "is_extendable": true,
        "is_overridable": true,
        "site_name": "<string>",
        "user_level_id": "<string>"
      },
      "ends_at": "2023-11-07T05:31:56Z",
      "is_backup": true,
      "is_scheduled_on_device": true,
      "is_waiting_for_code_assignment": true,
      "pulled_backup_access_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "starts_at": "2023-11-07T05:31:56Z"
    }
  ],
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  }
}

Authorizations

client_sessionclient_session_with_customerpat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

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

Body

application/json

access_code_ids · string<uuid>[]

IDs of the access codes that you want to retrieve. Specify device_id, access_code_ids, access_method_id, or access_grant_id.

access_grant_id · string<uuid>

ID of the access grant for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, or access_grant_id.

access_method_id · string<uuid>

ID of the access method for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, or access_grant_id.

customer_key · string

Customer key for which you want to list access codes.

device_id · string<uuid>

ID of the device for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, or access_grant_id.

limit · number<float> · default: 55000

Numerical limit on the number of access codes 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 access codes to include all records that satisfy a partial match using name, code or access_code_id.

Minimum string length: 1

user_identifier_key · string

Your user ID for the user by which to filter access codes.

Response

200

application/json

OK

access_codes · object[] · required

Show child attributes

ok · boolean · required

pagination · object · required

Information about the current page of results.

Show child attributes