Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
connect_webview_id
string<uuid>

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

connected_account_id
string<uuid>

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

connected_account_ids
string<uuid>[]

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

created_before
string<date-time>

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

custom_metadata_has
object

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

customer_key
string

Customer key for which you want to list devices.

device_ids
string<uuid>[]

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

device_type

Device type for which you want to list devices.

Available options:
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_types
enum<string>[]

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

Device type for smartlocks.

Available options:
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
limit
number<float>
default:500

Numerical limit on the number of devices to return.

manufacturer
enum<string>

Manufacturer for which you want to list devices.

Available options:
akuvox,
august,
avigilon_alta,
brivo,
butterflymx,
doorking,
four_suites,
genie,
igloo,
keywe,
kwikset,
linear,
lockly,
nuki,
philia,
salto,
samsung,
schlage,
seam,
unknown,
wyze,
yale,
two_n,
ttlock,
igloohome,
controlbyweb,
dormakaba_oracode,
tedee,
keyincode,
kisi,
akiles,
ecobee,
honeywell_resideo,
keynest,
korelock,
minut,
nest,
noiseaware,
sensi,
smartthings,
tado,
ultraloq,
ring,
ical,
lodgify,
hostaway,
guesty,
acuity_scheduling,
omnitec,
kisi,
slack
page_cursor
string | null

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

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.

Minimum string length: 1
space_id
string<uuid>

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

unstable_location_id
string<uuid> | null
deprecated

Deprecated. Use space_id.

user_identifier_key
string

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

Response

OK

devices
object[]
required
pagination
object
required

Information about the current page of results.