List Unmanaged Access Codes

Get all unmanaged access codes

Returns a list of all unmanaged access codes for a device.

The guide to migrating existing access codes provides an overview of the difference between managed and unmanaged access codes.

Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:

Kwikset

/access_codes/unmanaged/list

POSThttps://connect.getseam.com/access_codes/unmanaged/list

Authorization

client_sessionpat_with_workspaceconsole_sessionapi_key

Body

application/json

device_id*string (uuid)

user_identifier_keystring

Response

200400401

OK

Body

application/json

access_codes*array of unmanaged_access_code (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/access_codes/unmanaged/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "device_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "access_codes": [
    {
      "type": "time_bound",
      "access_code_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "code": "text",
      "created_at": "2024-07-27T06:34:39.127Z",
      "errors": [
        {
          "message": "text",
          "is_access_code_error": true,
          "error_code": "text"
        }
      ],
      "warnings": [
        {
          "message": "text",
          "warning_code": "text"
        }
      ],
      "is_managed": false,
      "starts_at": "2024-07-27T06:34:39.127Z",
      "ends_at": "2024-07-27T06:34:39.127Z",
      "status": "set"
    }
  ],
  "ok": false
}

---

Request

Filter the list of returned unmanaged access codes by device ID. You can also filter by user identifier key.

Request Body Parameters

Parameter	Type	Description
device_id	String (UUID) Required	ID of the devices for which to retrieve unmanaged access codes.
user_identifier_key	String Optional	Your own internal user ID for the user by which to filter unmanaged access codes.

Sample Request

Python

seam.access_codes.unmanaged.list(
  device_id="11111111-1111-1111-1111-444444444444"
)

# [AccessCode(
#   access_code_id='26d6138c-6524-4f3c-ac96-43cc3bea0a8d', 
#   type='ongoing', 
#   code='1988', 
#   name='Code 1', 
#   status='set'
#   )
#  ]

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/access_codes/unmanaged/list' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "11111111-1111-1111-1111-444444444444"
  }'

JavaScript

await seam.accessCodes.unmanaged.list({
  device_id: "11111111-1111-1111-1111-444444444444"
});

/*
[
  {
    code: '1988',
    name: 'Code 1',
    status: 'set',
    created_at: '2022-08-26T12:50:17.858Z',
    access_code_id: '26d6138c-6524-4f3c-ac96-43cc3bea0a8d'
  }
]
*/

PHP

$seam->access_codes->unmanaged->list(
  device_id: '11111111-1111-1111-1111-444444444444',
);

Ruby

seam.access_codes.unmanaged.list(
  device_id: "123e4567-e89b-12d3-a456-426614174000"
)

# [<Seam::AccessCode:0x007cd58
#   code="669781"
#   name="My first code"
#   created_at="2022-07-06T23:26:42.223Z"
#   access_code_id="f19bc8cb-15be-43af-bb52-f1a417e0ff09">]

---

Response

Returns an access_codes array, in which each returned access code (access_code) contains the set of applicable access code properties. For details, see Access Codes.

Sample Response

JSON

{
  "access_codes": [
    {
      "code": "1988",
      "name": "Code 1",
      "status": "set",
      "created_at": "2022-08-26T12:50:17.858Z",
      "access_code_id": "26d6138c-6524-4f3c-ac96-43cc3bea0a8d"
    },
    ...
  ],
  "ok": true
}