Installedapps

List Installed Apps

List all installed applications within the specified locations. If no locations are provided, then list all installed apps accessible by the principle.

get/installedapps

Request

Query parameters

locationIdstring ^(?:([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}))$

The ID of the Location that both the installed SmartApp and source are associated with.

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

State of the installed application

installedAppType'LAMBDA_SMART_APP' | 'WEBHOOK_SMART_APP'

Denotes the type of installed app.

tagstring ^[a-zA-Z_]{1,64}$

May be used to filter a resource by its assigned user-tags. Multiple tag query params are automatically joined with OR.

Example usage in query string:

?tag:key_name=value1&tag:key_name=value2
appIdstring ^[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}$

The ID of an App

modeIdstring ^(?:([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}))$

The ID of the mode

deviceIdstring ^(?:([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}))$

The ID of the Device

Headers

Authorizationstring string required

OAuth token

Response

A paginated list of installed apps.

Example response

{
  "items": [
    {
      "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
    }
  ],
  "_links": {
    "next": {
      "href": "https://..."
    },
    "previous": {
      "href": "https://..."
    }
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.