githubEdit

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.

circle-info

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

Kwikset

/access_codes/unmanaged/list

post

Returns a list of all unmanaged access codes.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
device_idstring · uuidRequired

ID of the device for which you want to list unmanaged access codes.

user_identifier_keystringOptional

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

limitnumber · floatOptional

Numerical limit on the number of unmanaged access codes to return.

Default: 300000
searchstring · min: 1Optional

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.

page_cursorstring · nullableOptional

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

Responses
chevron-right
200

OK

application/json
okbooleanRequired
post
/access_codes/unmanaged/list

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


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

Last updated

Was this helpful?