Preferences

Get Preference by ID

Get a preference by preference ID.

get/devicepreferences/{preferenceId}

Request

Base URL
https://api.smartthings.com/v1
Auth
OAuth 2
Implicithttps://auth-global.api.smartthings.com
Scopesr:customcapabilities:*
TypeScript
https://skmtc.dev/smartthings/apis/smartthings-api/docs/devicepreferences/:preferenceId/get.ts
A function with typed inputs. Its response is checked against the schema.

successful return of preference

preferenceIdstring

The ID of the preference

namestring

An alphanumeric English language name for this preference.

titlestring required

A short description for this preference.

descriptionstring

A long description for this preference.

requiredboolean

A flag describing whether this property is required or not.

explicitboolean

A flag describing whether this preference is explicit, or inline.

preferenceType'integer' | 'number' | 'boolean' | 'string' | 'enumeration' required

The type of preference this is.

{
  "title": "Temperature Offset",
  "description": "The offset for a particular temperature setting"
}