SMsmartthings
Devices

List Devices

Changed on

Get a list of devices.

get/devices

Request

Query parameters

capabilitystring[]

The device capabilities to filter the results by. The capabilities are treated as an "and" so all capabilities must be present.

locationIdstring[]

The device locations to filter the results by.

deviceIdstring[]

The device IDs to filter the results by.

capabilitiesMode'or' | 'and'

Treat all capability filter query params as a logical "or" or "and" with a default of "and".

includeRestrictedboolean

Restricted devices are hidden by default. This query parameter will reveal them. Device status will not be provided if the token does not have sufficient access level to view the device status even if includeStatus parameter is set to true.

accessLevelinteger

Only list devices accessible by the given accessLevel.

includeAllowedActionsboolean

Include the actions permitted by this token's access for each individual resource.

includeStatusboolean

Include the status of the device's capabilities, if permission is adequate to view them. This requires r:devices permission.

includeHealthboolean

Include the health status of the device. Requires r:devices permission.

includeHiddenDevicesboolean

Include hidden devices in the results. Requires r:devices permission.

Response

A list of devices.

Changes

  • 2788a4236800Revision changes
    • info

      the security scope l:devices was added to the endpoint's security scheme Bearer

    • info

      the security scope r:devices:* was removed from the endpoint's security scheme Bearer

    • info

      added the new optional query request parameter includeHiddenDevices

  • 145c21700100Revision changes
    • info

      the security scope l:devices was added to the endpoint's security scheme Bearer

    • info

      the security scope r:devices:* was removed from the endpoint's security scheme Bearer

    • info

      added the new optional query request parameter includeHealth

    • info

      added the new optional query request parameter includeStatus