Function useDevices

Parameters

• Optionalparams: {
      connect_webview_id?: string;
      connected_account_id?: string;
      connected_account_ids?: string[];
      created_before?: Date;
      custom_metadata_has?: {
          [x: string]: string | boolean;
      };
      customer_key?: string;
      device_ids?: string[];
      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"
          | "seam_relay"
          | "smartthings_lock"
          | "wyze_lock"
          | "yale_lock"
          | "two_n_intercom"
          | "controlbyweb_device"
          | "ttlock_lock"
          | "igloohome_lock"
          | "hubitat_lock"
          | "four_suites_door"
          | "dormakaba_oracode_door"
          | "tedee_lock"
          | "akiles_lock"
          | "ultraloq_lock"
          | "keynest_key"
          | "noiseaware_activity_zone"
          | "minut_sensor"
          | "ecobee_thermostat"
          | "nest_thermostat"
          | "honeywell_resideo_thermostat"
          | "tado_thermostat"
          | "sensi_thermostat"
          | "smartthings_thermostat"
          | "ios_phone"
          | "android_phone";
      device_types?: (
          | "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"
          | "seam_relay"
          | "smartthings_lock"
          | "wyze_lock"
          | "yale_lock"
          | "two_n_intercom"
          | "controlbyweb_device"
          | "ttlock_lock"
          | "igloohome_lock"
          | "hubitat_lock"
          | "four_suites_door"
          | "dormakaba_oracode_door"
          | "tedee_lock"
          | "akiles_lock"
          | "ultraloq_lock"
          | "keynest_key"
          | "noiseaware_activity_zone"
          | "minut_sensor"
          | "ecobee_thermostat"
          | "nest_thermostat"
          | "honeywell_resideo_thermostat"
          | "tado_thermostat"
          | "sensi_thermostat"
          | "smartthings_thermostat"
          | "ios_phone"
          | "android_phone")[];
      exclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription")[];
      include_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription")[];
      limit?: number;
      manufacturer?:
          | "unknown"
          | "doorking"
          | "ecobee"
          | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "four_suites"
          | "genie"
          | "igloo"
          | "keywe"
          | "kwikset"
          | "linear"
          | "lockly"
          | "nuki"
          | "philia"
          | "salto"
          | "samsung"
          | "schlage"
          | "seam"
          | "wyze"
          | "yale"
          | "two_n"
          | "ttlock"
          | "igloohome"
          | "hubitat"
          | "controlbyweb"
          | "dormakaba_oracode"
          | "tedee"
          | "akiles"
          | "honeywell_resideo"
          | "kwikset2"
          | "minut"
          | "nest"
          | "noiseaware"
          | "tado"
          | "sensi"
          | "smartthings"
          | "keynest"
          | "ultraloq";
      page_cursor?: null | string;
      search?: string;
      space_id?: string;
      unstable_location_id?: null | string;
      user_identifier_key?: string;
  }

  • Optionalconnect_webview_id?: string

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

  • Optionalconnected_account_id?: string

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

  • Optionalconnected_account_ids?: string[]

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

  • Optionalcreated_before?: Date

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

  • Optionalcustom_metadata_has?: {
        [x: string]: string | boolean;
    }

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

    • [x: string]: string | boolean

  • Optionalcustomer_key?: string

    Customer key for which you want to list devices.

  • Optionaldevice_ids?: string[]

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

  • Optionaldevice_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"
        | "seam_relay"
        | "smartthings_lock"
        | "wyze_lock"
        | "yale_lock"
        | "two_n_intercom"
        | "controlbyweb_device"
        | "ttlock_lock"
        | "igloohome_lock"
        | "hubitat_lock"
        | "four_suites_door"
        | "dormakaba_oracode_door"
        | "tedee_lock"
        | "akiles_lock"
        | "ultraloq_lock"
        | "keynest_key"
        | "noiseaware_activity_zone"
        | "minut_sensor"
        | "ecobee_thermostat"
        | "nest_thermostat"
        | "honeywell_resideo_thermostat"
        | "tado_thermostat"
        | "sensi_thermostat"
        | "smartthings_thermostat"
        | "ios_phone"
        | "android_phone"

    Device type for which you want to list devices.

  • Optionaldevice_types?: (
        | "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"
        | "seam_relay"
        | "smartthings_lock"
        | "wyze_lock"
        | "yale_lock"
        | "two_n_intercom"
        | "controlbyweb_device"
        | "ttlock_lock"
        | "igloohome_lock"
        | "hubitat_lock"
        | "four_suites_door"
        | "dormakaba_oracode_door"
        | "tedee_lock"
        | "akiles_lock"
        | "ultraloq_lock"
        | "keynest_key"
        | "noiseaware_activity_zone"
        | "minut_sensor"
        | "ecobee_thermostat"
        | "nest_thermostat"
        | "honeywell_resideo_thermostat"
        | "tado_thermostat"
        | "sensi_thermostat"
        | "smartthings_thermostat"
        | "ios_phone"
        | "android_phone")[]

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

  • Optionalexclude_if?: (
        | "can_remotely_unlock"
        | "can_remotely_lock"
        | "can_program_offline_access_codes"
        | "can_program_online_access_codes"
        | "can_hvac_heat"
        | "can_hvac_cool"
        | "can_hvac_heat_cool"
        | "can_turn_off_hvac"
        | "can_simulate_removal"
        | "can_simulate_connection"
        | "can_simulate_disconnection"
        | "can_unlock_with_code"
        | "can_run_thermostat_programs"
        | "can_program_thermostat_programs_as_weekday_weekend"
        | "can_program_thermostat_programs_as_different_each_day"
        | "can_program_thermostat_programs_as_same_each_day"
        | "can_simulate_hub_connection"
        | "can_simulate_hub_disconnection"
        | "can_simulate_paid_subscription")[]

  • Optionalinclude_if?: (
        | "can_remotely_unlock"
        | "can_remotely_lock"
        | "can_program_offline_access_codes"
        | "can_program_online_access_codes"
        | "can_hvac_heat"
        | "can_hvac_cool"
        | "can_hvac_heat_cool"
        | "can_turn_off_hvac"
        | "can_simulate_removal"
        | "can_simulate_connection"
        | "can_simulate_disconnection"
        | "can_unlock_with_code"
        | "can_run_thermostat_programs"
        | "can_program_thermostat_programs_as_weekday_weekend"
        | "can_program_thermostat_programs_as_different_each_day"
        | "can_program_thermostat_programs_as_same_each_day"
        | "can_simulate_hub_connection"
        | "can_simulate_hub_disconnection"
        | "can_simulate_paid_subscription")[]

  • Optionallimit?: number

    Numerical limit on the number of devices to return.

  • Optionalmanufacturer?:
        | "unknown"
        | "doorking"
        | "ecobee"
        | "akuvox"
        | "august"
        | "avigilon_alta"
        | "brivo"
        | "butterflymx"
        | "four_suites"
        | "genie"
        | "igloo"
        | "keywe"
        | "kwikset"
        | "linear"
        | "lockly"
        | "nuki"
        | "philia"
        | "salto"
        | "samsung"
        | "schlage"
        | "seam"
        | "wyze"
        | "yale"
        | "two_n"
        | "ttlock"
        | "igloohome"
        | "hubitat"
        | "controlbyweb"
        | "dormakaba_oracode"
        | "tedee"
        | "akiles"
        | "honeywell_resideo"
        | "kwikset2"
        | "minut"
        | "nest"
        | "noiseaware"
        | "tado"
        | "sensi"
        | "smartthings"
        | "keynest"
        | "ultraloq"

    Manufacturer for which you want to list devices.

  • Optionalpage_cursor?: null | string

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

  • Optionalsearch?: string

    String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id, display_name, custom_metadata or location.location_name.

  • Optionalspace_id?: string

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

  • Optionalunstable_location_id?: null | string

    Deprecated

    Use space_id.

  • Optionaluser_identifier_key?: string

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