Sign in

v1

latestOpenAPI 3.0.02026-07-22201291.8 MB
/locks

List Locks

Returns a list of all locks.

post/locks/list

Request body

connect_webview_idstring uuid

ID of the Connect Webview for which you want to list devices.

connected_account_idstring uuid

ID of the connected account for which you want to list devices.

connected_account_idsstring[]

Array of IDs of the connected accounts for which you want to list devices.

created_beforestring date-time

Timestamp by which to limit returned devices. Returns devices created before this timestamp.

custom_metadata_hasobject

Set of key:value custom metadata pairs for which you want to list devices.

customer_keystring

Customer key for which you want to list devices.

device_idsstring[]

Array of device IDs for which you want to list devices.

device_type'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock'

Device type of the locks that you want to list.

device_typesstring[]

Device types of the locks that you want to list.

limitnumber float

Numerical limit on the number of devices to return.

manufacturer'akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'kisi' | 'akiles' | 'korelock' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi'

Manufacturer of the locks that you want to list.

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 devices to include all records that satisfy a partial match using device_id (full or partial UUID prefix, minimum 4 characters), connected_account_id, display_name, custom_metadata or location.location_name.

space_idstring uuid

ID of the space for which you want to list devices.

unstable_location_idstring uuid nullable

Deprecated. Use space_id.

user_identifier_keystring

Your own internal user ID for the user for which you want to list devices.

Response

OK