SMsmartthings
Installedapps

Get an Installed App

Changed on

Fetch a single installed application.

get/installedapps/{installedAppId}

Request

Path parameters

installedAppIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

The ID of the installed application.

Query parameters

allowedboolean

If set to true, the item in the response will contain the allowed list property.

Headers

Authorizationstring string required

OAuth token

Response

An installed app.

installedAppIdstring uuid required

The ID of the installed app.

installedAppType'LAMBDA_SMART_APP' | 'WEBHOOK_SMART_APP' required

Denotes the type of installed app.

installedAppStatus'PENDING' | 'AUTHORIZED' | 'REVOKED' | 'DISABLED' required

Denotes the current state of an install. 'PENDING' is used during active modification to the install's config prior to 'AUTHORIZATION'. A status of 'AUTHORIZED' means the install's permissions have been authorized by the consumer. Installed Apps in 'AUTHORIZED' state are fully installed and usable by the SmartThings platform. A status of 'REVOKED' means the install's permissions have been revoked. A status of 'DISABLED' means a previously 'AUTHORIZED' Installed App will not execute.

displayNamestring

A user defined name for the installed app. May be null.

appIdstring required

The ID of the app.

referenceIdstring

A reference to an upstream system. For example, Behaviors would reference the behaviorId. May be null.

locationIdstring uuid

The ID of the location to which the installed app may belong.

createdDatestring date-time required

A UTC ISO-8601 Date-Time String

lastUpdatedDatestring date-time required

A UTC ISO-8601 Date-Time String

classificationsstring[] required

An App maybe associated to many classifications. A classification drives how the integration is presented to the user in the SmartThings mobile clients. These classifications include:

  • AUTOMATION - Denotes an integration that should display under the "Automation" tab in mobile clients.
  • SERVICE - Denotes an integration that is classified as a "Service".
  • DEVICE - Denotes an integration that should display under the "Device" tab in mobile clients.
  • CONNECTED_SERVICE - Denotes an integration that should display under the "Connected Services" menu in mobile clients.
  • HIDDEN - Denotes an integration that should not display in mobile clients
  • LABS - Denotes an ingration that should display under the "Labs" menu in the modile clients.
principalType'LOCATION' | 'USER_LEVEL' | 'ACCOUNT_LEVEL' required

Denotes the principal type to be used with the app. Default is LOCATION.

restrictionTierinteger

Restriction tier of the install, if any.

singleInstanceboolean required

Inform the installation systems that the associated app can only be installed once within a user's account.

allowedstring[]

List of client-facing action identifiers that are currently permitted for the user. If the value of this property is not null, then any action not included in the list value of the property is currently prohibited for the user. If the value of this property is null (or absent), then no permission-related information is being provided.

<ul> <li>`"w:installedapps"` -- the user has update permissions on the installed app</li> <li>`"d:installedapps"` -- the user has delete permissions on the installed app</li> </ul>

Example response

{
  "installedAppId": "8885b9c3-a50d-427e-ad07-d7a2f94421af",
  "installedAppType": "WEBHOOK_SMART_APP",
  "installedAppStatus": "PENDING",
  "displayName": "Color App",
  "appId": "fdd21b3e-5880-44c8-9f61-ce474814f587",
  "referenceId": "c71b0a5b-7dab-41fe-b75f-7cf30246468e",
  "locationId": "4ae86cfc-63be-4bcc-8514-836c873b4d7a",
  "owner": {
    "ownerType": "USER",
    "ownerId": "3f178632-79ed-4358-94de-280dbd7c206c"
  },
  "notices": [
    "USER_PAUSE",
    "REVISIT",
    "RECONFIGURE"
  ],
  "createdDate": "2017-05-19T12:39:37Z",
  "lastUpdatedDate": "2017-05-19T12:39:37Z",
  "allowed": [
    "w:installedapps",
    "d:installedapps"
  ],
  "classifications": [
    "AUTOMATION",
    "LABS"
  ],
  "principalType": "LOCATION",
  "singleInstance": false
}

Changes