Get an Access Code

Returns a specified access code.

You must specify either access_code_id or both device_id and code.

POST /access_codes/get

JavaScript

Seam SDK

await seam.accessCodes.get({ access_code_id: "90a114dc-48b5-4b8b-a3d3-972344594401", }); /* { "access_code_id": "90a114dc-48b5-4b8b-a3d3-972344594401", "code": "1234", "common_code_key": null, "created_at": "2025-06-14T16:54:17.946242Z", "device_id": "7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5", "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_code": {
    "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_managed": true,
    "is_offline_access_code": true,
    "is_one_time_use": true,
    "name": "<string>",
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "mutation_code": "creating"
      }
    ],
    "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
}

Authorizations

api_keypat_with_workspaceconsole_session_with_workspaceclient_sessionclient_session_with_customer

Authorization · string · header · required

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

Body

application/json

access_code_id · string<uuid>

ID of the access code that you want to get. You must specify either access_code_id or both device_id and code.

code · string

Code of the access code that you want to get. You must specify either access_code_id or both device_id and code.

device_id · string<uuid>

ID of the device containing the access code that you want to get. You must specify either access_code_id or both device_id and code.

Response

200

application/json

OK

access_code · object · required

Represents a smart lock access code.

Show child attributes

ok · boolean · required