Fetch details of an app

Prev Next
Get
/api/apps/{appId}

Get all the details of an app in your workspace. The app must already be installed in your workspace. Permission required: Manage Apps.

Header parameters
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Path parameters
appId
stringRequired

The id of the app

Exampled05142b1-60b6-4562-9940-86be9b548f43
Responses
200

OK

Fetch app details
{
  "app": {
    "id": "d05142b1-60b6-4562-9940-86be9b548f43",
    "version": "6.5.0",
    "requiredApiVersion": "^1.40.0",
    "iconFile": "icon.png",
    "author": {
      "name": "Neal Richardson",
      "homepage": "https://www.bluescape.com",
      "support": "neal.richardson@bluescape.com"
    },
    "name": "bluescape",
    "nameSlug": "bluescape",
    "classFile": "BluescapeApp.js",
    "description": "bluescape workspace slash commands",
    "implements": [],
    "permissions": [
      {
        "name": "user.read"
      },
      {
        "name": "server-setting.read"
      },
      {
        "name": "room.read"
      },
      {
        "name": "message.read"
      },
      {
        "name": "message.write"
      },
      {
        "name": "slashcommand"
      },
      {
        "name": "networking"
      }
    ],
    "iconFileContent": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAARAAAAEOCAYAAABB1kj+AAAACXBIWXMAABcSAAAXEgFnn9JSAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVem+eTkQnk2OXqkmo/0sAVkTQSsfOHuQph8pzJ6Bx1ti0961GvdLw7tknT0p5v51z790bM5Jst+w3Ks/niM3lkAlk7epEliyETx7FJ5ETP63J/+0yvs2pp3Ewep7lHkJGRkZEJJCMjIxNIRkZGJpCMjIxMIBkZGRmZQDIyMjKBZGRkZALJyMg4U7HqhWSquXEhIyNbIBkZGRmZQDIyMjKBZGRkZALJyMjIBJKRkZGRCSQjIyMTSEZGRiaQjIyMTCAZGRlnBZZUotZp1GFGRkbGJDc8I4E8+uij+UxlZGRkFyYjIyMTSEZGRiaQjIyM9Yb/fwBLYM4biudGLgAAAABJRU5ErkJggg==",
    "status": "manually_enabled",
    "languages": {},
    "private": false,
    "migrated": false
  },
  "success": true
}
Expand All
object
app
object
id
string
version
string
requiredApiVersion
string
iconFile
string
author
object
name
string
homepage
string
support
string
name
string
nameSlug
string
classFile
string
description
string
implements
Array of object
object
permissions
Array of object
object
name
string
iconFileContent
string
status
string
languages
object
private
boolean
migrated
boolean
success
boolean
400

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string