Sign in

v1

latestOpenAPI 3.0.02026-07-22201291.8 MB
/access_codes

List Access Codes

Returns a list of all access codes.

Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

post/access_codes/list

Request body

access_code_idsstring[]

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

access_grant_idstring uuid

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

access_grant_keystring

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

access_method_idstring uuid

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

customer_keystring

Customer key for which you want to list access codes.

device_idstring uuid

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

limitnumber float

Numerical limit on the number of access codes to return.

page_cursorstring nullable

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

searchstring

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.

user_identifier_keystring

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

Response

OK