Samsung SmartThings
App · 20 actions
Read devices, rooms, locations, modes, scenes and rules; control devices and modes.
Actions
| Action | What it does |
|---|---|
| Create room | Create room. |
| Delete room | Delete room. |
| Execute scene | Execute scene. |
| Get capability status | Get capability status. |
| Get component status | Get component status. |
| Get current mode | Get current mode. |
| Get device | Get device. |
| Get device health | Get device health. |
| Get device status | Get device status. |
| Get location | Get location. |
| Get room | Get room. |
| Get rule | Get rule. |
| List devices | List devices. |
| List locations | List locations. |
| List modes | List modes. |
| List rooms | List rooms. |
| List rules | List rules. |
| List scenes | List scenes. |
| Send device commands | Send device commands. |
| Set current mode | Set current mode. |
Create room
Create room.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Allowed
allowedtext - If set to true, the response may contain the allowed list property. Note that setting this to true may significantly slow the response time. If you are creating a room for your own account, then you know you will have all these permissions and can avoid the trouble of passing in this parameter.
- Name
nametextRequired - A name for the room (e.g. Living Room)
- Indoor map
indoor_mapobject - Data used for indoor map
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"allowed": [],
"backgroundImage": "example",
"created": "example",
"indoorMap": {
"color": "example",
"mapRoomId": "example"
},
"lastModified": "example",
"locationId": "example",
"name": "example",
"roomId": "example"
},
"has_more": false,
"next_cursor": null
}Delete room
Delete room.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Room
room_idtextRequired - The ID of the Room.
Outputs
Response.
dataobject- An empty object response.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Execute scene
Execute scene.
Inputs
- Location
location_idtext - The location of a scene.
- Scene
scene_idtextRequired - The ID of the Scene.
Outputs
Response.
dataobject- {"status": "success"}
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"status": "success"
},
"has_more": false,
"next_cursor": null
}Get capability status
Get capability status.
Inputs
- Device
device_idtextRequired - The Device ID
- Component
component_idtextRequired - The name of the component.
- Capability
capability_idtextRequired - The ID of the capability
Outputs
Response.
dataobject- A map of attribute name to attribute state.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get component status
Get component status.
Inputs
- Device
device_idtextRequired - The Device ID
- Component
component_idtextRequired - The name of the component.
Outputs
Response.
dataobject- A map of capabilityId to capability status.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get current mode
Get current mode.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"allowed": [],
"id": "example",
"label": "example",
"locationId": "example",
"name": "example"
},
"has_more": false,
"next_cursor": null
}Get device
Get device.
Inputs
- Device
device_idtextRequired - The Device ID
- Include status
include_statustrue/false - Include the status of the device's capabilities, if permission is adequate to view them. This requires `r:devices` permission.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"allowed": [],
"app": {
"externalId": "example",
"installedAppId": "example",
"profile": {
"id": "example"
}
},
"ble": {},
"bleD2D": {
"advertisingId": "example",
"bleDeviceType": "example",
"cipher": "example",
"configurationUrl": "example",
"configurationVersion": "example",
"encryptionKey": "example",
"gattCipher": "example",
"identifier": "example",
"metadata": {}
},
"brandId": "example",
"childDevices": [],
"components": [],
"createTime": "example",
"deviceId": "example",
"deviceManufacturerCode": "example",
"deviceNetworkType": "example",
"deviceTypeId": "example",
"deviceTypeName": "example",
"dth": {
"completedSetup": false,
"deviceNetworkType": "example",
"deviceTypeId": "example",
"deviceTypeName": "example",
"executingLocally": false,
"fingerprintId": "example",
"fingerprintType": "DTH",
"hubId": "example",
"installedGroovyAppId": "example",
"networkId": "example",
"networkSecurityLevel": "UNKNOWN"
},
"edgeChild": {
"driverId": "example",
"executingLocally": false,
"fingerprintId": "example",
"fingerprintType": "DTH",
"hubId": "example",
"networkId": "example",
"parentAssignedChildKey": "example",
"provisioningState": "PROVISIONED"
},
"executionContext": "LOCAL",
"group": {
"devices": [],
"groupName": "example",
"groupType": "UNDETERMINED"
},
"healthState": {
"lastUpdatedDate": "example",
"state": "ONLINE"
},
"hub": {
"driverId": "example",
"firmwareVersion": "example",
"hubData": {
"childDeviceAvailability": "Available",
"edgeDriverSupportedEndpointApps": {
"apps": []
},
"edgeDriversAvailability": "Available",
"enrollmentChannel": "PUBLIC",
"failoverAvailability": "Available",
"hardwareId": "example",
"hardwareType": "example",
"hedgeTlsCertificate": "example",
"hub2hubSupportMatrix": {
"capabilities": []
},
"hubLocalApiAvailability": "Available",
"hubLocalApiJwkOfflineRetentionSeconds": 1,
"hubReplaceAvailability": "Available",
"lanAvailability": "Available",
"localIP": "example",
"localVirtualDeviceAvailability": "Available",
"macAddress": "example",
"matterAvailability": "Available",
"matterCommissionerSupport": {
"supportedModes": [],
"version": 1
},
"matterDeviceDiagnosticsAvailability": "Available",
"matterRendezvousHedgeSupported": false,
"matterSoftwareComponentVersion": "example",
"otaEnable": "example",
"primaryHubDeviceId": "example",
"primarySupportAvailability": "Available",
"repeaterReachability": "Unknown",
"secondarySupportAvailability": "Available",
"serialNumber": "example",
"threadAvailability": "Available",
"threadRequiresExternalHardware": false,
"wifiSsid": "example",
"zigbee3": false,
"zigbeeAvailability": "Available",
"zigbeeChannel": "example",
"zigbeeDeviceDiagnosticsAvailability": "Available",
"zigbeeEui": "example",
"zigbeeFirmware": "example",
"zigbeeManualFirmwareUpdateSupported": false,
"zigbeeNodeID": "example",
"zigbeeOta": "DISABLED",
"zigbeePanId": "example",
"zigbeeRadioDetected": false,
"zigbeeRadioEnabled": false,
"zigbeeRadioFunctional": false,
"zigbeeRequiresExternalHardware": false,
"zigbeeUnsecureRejoin": false,
"zwaveAvailability": "Available",
"zwaveHomeID": "example",
"zwaveNodeID": "example",
"zwaveRadioDetected": false,
"zwaveRadioEnabled": false,
"zwaveRadioFunctional": false,
"zwaveRegion": "example",
"zwaveS2": false,
"zwaveStaticDsk": "example",
"zwaveSucID": "example",
"zwaveVersion": "example"
},
"hubDrivers": [],
"hubEui": "example"
},
"indoorMap": {
"coordinates": [
1,
1,
1
],
"data": {},
"rotation": [
1,
1,
1
],
"visible": false
},
"ir": {
"childDevices": [],
"functionCodes": {
"default": "example"
},
"irCode": "example",
"metadata": {},
"ocfDeviceType": "example",
"parentDeviceId": "example",
"profileId": "example"
},
"irOcf": {
"childDevices": [],
"functionCodes": {
"default": "example"
},
"irCode": "example",
"metadata": {},
"ocfDeviceType": "example",
"parentDeviceId": "example",
"profileId": "example"
},
"label": "example",
"lan": {
"driverId": "example",
"executingLocally": false,
"fingerprintId": "example",
"fingerprintType": "DTH",
"hubId": "example",
"networkId": "example",
"provisioningState": "PROVISIONED"
},
"locationId": "example",
"manufacturerName": "example",
"matter": {
"driverId": "example",
"endpoints": [],
"executingLocally": false,
"fingerprintId": "example",
"fingerprintType": "DTH",
"hubId": "example",
"listeningType": "ALWAYS",
"networkId": "example",
"productId": 1,
"provisioningState": "PROVISIONED",
"serialNumber": "example",
"supportedNetworkInterfaces": [],
"syncDrivers": false,
"uniqueId": "example",
"vendorId": 1,
"version": {
"hardware": 1,
"hardwareLabel": "example",
"software": 1,
"softwareLabel": "example"
}
},
"mqtt": {
"authCodeRequired": false,
"executingLocally": false,
"hubId": "example",
"transferCandidate": false
},
"name": "example",
"ocf": {
"additionalAuthCodeRequired": false,
"firmwareVersion": "example",
"hwVersion": "example",
"lastSignupTime": "example",
"locale": "example",
"manufacturerName": "example",
"modelCode": "example",
"modelNumber": "example",
"name": "example",
"ocfDeviceType": "example",
"platformOS": "example",
"platformVersion": "example",
"specVersion": "example",
"transferCandidate": false,
"vendorId": "example",
"vendorResourceClientServerVersion": "example",
"verticalDomainSpecVersion": "example"
},
"ownerId": "example",
"parentDeviceId": "example",
"presentationId": "example",
"productId": "example",
"profile": {
"id": "example"
},
"relationships": [],
"restrictionTier": 1,
"roomId": "example",
"type": "BLE",
"viper": {
"endpointAppId": "example",
"hwVersion": "example",
"manufacturerName": "example",
"modelName": "example",
"swVersion": "example",
"uniqueIdentifier": "example"
},
"virtual": {
"commandMappings": {
"commands": []
},
"driverId": "example",
"executingLocally": false,
"hubId": "example",
"name": "example"
},
"zigbee": {
"driverId": "example",
"eui": "example",
"executingLocally": false,
"fingerprintId": "example",
"fingerprintType": "DTH",
"hubId": "example",
"networkId": "example",
"provisioningState": "PROVISIONED"
},
"zwave": {
"driverId": "example",
"executingLocally": false,
"fingerprintId": "example",
"fingerprintType": "DTH",
"hubId": "example",
"manufacturerId": 1,
"networkId": "example",
"networkSecurityLevel": "UNKNOWN",
"productId": 1,
"productType": 1,
"provisioningState": "PROVISIONED"
}
},
"has_more": false,
"next_cursor": null
}Get device health
Get device health.
Inputs
- Device
device_idtextRequired - The Device ID
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"deviceId": "example",
"lastUpdatedDate": "example",
"state": "ONLINE"
},
"has_more": false,
"next_cursor": null
}Get device status
Get device status.
Inputs
- Device
device_idtextRequired - The Device ID
Outputs
Response.
dataobject- The status of a device.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"components": {},
"deviceId": "example",
"healthState": {
"lastUpdatedDate": "example",
"state": "ONLINE"
}
},
"has_more": false,
"next_cursor": null
}Get location
Get location.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Allowed
allowedtext - If set to true, the items in the response may contain the allowed list property
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"additionalProperties": {},
"allowed": [],
"backgroundImage": "example",
"countryCode": "example",
"created": "example",
"lastModified": "example",
"latitude": 1,
"locale": "example",
"locationId": "example",
"longitude": 1,
"name": "example",
"parent": {
"id": "example",
"type": "LOCATIONGROUP"
},
"regionRadius": 1,
"temperatureScale": "example",
"timeZoneId": "example"
},
"has_more": false,
"next_cursor": null
}Get room
Get room.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Room
room_idtextRequired - The ID of the Room.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"allowed": [],
"backgroundImage": "example",
"created": "example",
"indoorMap": {
"color": "example",
"mapRoomId": "example"
},
"lastModified": "example",
"locationId": "example",
"name": "example",
"roomId": "example"
},
"has_more": false,
"next_cursor": null
}Get rule
Get rule.
Inputs
- Rule
rule_idtextRequired - The rule ID
- Location
location_idtextRequired - The ID of the Location containing the Rule you wish to retrieve.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"actions": [],
"allowed": [],
"creator": "SMARTTHINGS",
"dateCreated": "example",
"dateExecuted": "example",
"dateUpdated": "example",
"executionLocation": "Cloud",
"id": "example",
"name": "example",
"ownerId": "example",
"ownerType": "Location",
"sequence": {
"actions": "Serial"
},
"status": "Enabled",
"timeZoneId": "example"
},
"has_more": false,
"next_cursor": null
}List devices
List devices.
Inputs
- Capability
capabilitylist - The device capabilities to filter the results by. The capabilities are treated as an "and" so all capabilities must be present.
- Location
location_idlist - The device locations to filter the results by.
- Device
device_idlist - The device IDs to filter the results by.
- Capabilities mode
capabilities_modetext - Treat all capability filter query params as a logical "or" or "and" with a default of "and".One of:
or,and. - Include restricted
include_restrictedtrue/false - 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.
- Access level
access_levelnumber - Only list devices accessible by the given accessLevel.
- Include allowed actions
include_allowed_actionstrue/false - Include the actions permitted by this token's access for each individual resource.
- Include status
include_statustrue/false - Include the status of the device's capabilities, if permission is adequate to view them. This requires `r:devices` permission.
- Include health
include_healthtrue/false - Include the health status of the device. Requires `r:devices` permission.
- Include hidden devices
include_hidden_devicestrue/false - Include hidden devices in the results. Requires `r:devices` permission.
- Cursor
cursortext - Cursor.
Outputs
Response.
dataobject- A paginated array of devices.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"next": {
"href": "example"
},
"previous": {
"href": "example"
}
},
"items": []
},
"has_more": false,
"next_cursor": null
}List locations
List locations.
Inputs
- Allowed
allowedtext - If set to true, the items in the response may contain the allowed list property
- Limit
limitnumber - Maximum number of Locations returned in a paged result set.
- Page
pagetext - Next page result set key.
- Cursor
cursortext - Cursor.
Outputs
Response.
dataobject- Represents a single page of Locations available in a user account.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"next": {
"href": "example"
},
"previous": {
"href": "example"
}
},
"items": []
},
"has_more": false,
"next_cursor": null
}List modes
List modes.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Cursor
cursortext - Cursor.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"items": []
},
"has_more": false,
"next_cursor": null
}List rooms
List rooms.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Cursor
cursortext - Cursor.
Outputs
Response.
dataobject- Represents a single page of Rooms available in a Location.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"next": {
"href": "example"
},
"previous": {
"href": "example"
}
},
"items": []
},
"has_more": false,
"next_cursor": null
}List rules
List rules.
Inputs
- Location
location_idtextRequired - The ID of the Location you want to list Rules for.
- Include all parents
include_all_parentstext - If set to true, all rules are returned
- Max
maxnumber - The max number of Rules to fetch
- Offset
offsetnumber - The start index of Rules to fetch
- Cursor
cursortext - Cursor.
Outputs
Response.
dataobject- An array of Rules
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"next": {
"href": "example"
},
"previous": {
"href": "example"
}
},
"items": []
},
"has_more": false,
"next_cursor": null
}List scenes
List scenes.
Inputs
- Location
location_idtext - The location of a scene.
- Cursor
cursortext - Cursor.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"_links": {
"next": {
"href": "example"
},
"previous": {
"href": "example"
}
},
"items": []
},
"has_more": false,
"next_cursor": null
}Send device commands
Send device commands.
Inputs
- Device
device_idtextRequired - The Device ID
- Ordered
orderedtrue/false - This parameter has been deprecated. Functionality is not guaranteed. Specifies whether the command should be executed in order or asynchronously.
- Commands
commandslistRequired - An array of commands to execute on the device.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"results": []
},
"has_more": false,
"next_cursor": null
}Set current mode
Set current mode.
Inputs
- Location
location_idtextRequired - A unique location identifier. This is not guaranteed to be a valid UUID.
- Mode
mode_idtextRequired - Update the current Mode for this Location to the given Mode ID.
Outputs
Response.
dataobject- Data.
has_moretrue/false- Whether more records are available.
next_cursortext- Continuation token, if another page exists.
Example output
{
"data": {
"id": "example",
"label": "example",
"name": "example"
},
"has_more": false,
"next_cursor": null
}