List app scopes | Sample

1 parameter

tokenstringrequired

Authentication token for the app; the required scope is `none`.

2 status codes

200Returns an object with `ok` set to true and a `scopes` object containing granted scopes grouped by resource type.

okbooleanrequired

Allowed:true

scopesobjectrequired

defaultReturned when authentication, authorization, or request validation fails; the response contains `ok` set to false and an `error` value.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

token must contain a valid authentication token with the required none scope. The request must use the supported parameter format for the token.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.appsPermissionsScopesList.list({ token: "sk_live_4eC39Hq" });

{
  "ok": true,
  "scopes": {
    "app_home": [
      "chat:write",
      "im:history",
      "im:read"
    ],
    "channel": [
      "channels:history",
      "chat:write"
    ],
    "group": [
      "chat:write"
    ],
    "im": [
      "chat:write"
    ],
    "mpim": [
      "chat:write"
    ],
    "team": [
      "users:read"
    ],
    "user": []
  }
}

Request

Response

Errors