List app resource grants | Sample

3 parameters

tokenstringrequired

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

cursorstringoptional

Pagination cursor from a previous response's `response_metadata.next_cursor`; omit it to retrieve the first page.

limitintegeroptional

Maximum number of resource grants to return.

2 status codes

200Returns an object with `ok` set to true, a `resources` array containing resource grants, and `response_metadata.next_cursor` for pagination.

okbooleanrequired

Allowed:true

resourcesarray<object>required

response_metadataobjectoptional

defaultReturned when authentication, authorization, pagination, 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:invalid_cursornot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requireduser_is_botinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_data

okbooleanrequired

Allowed:false

Error handling

token must contain a valid authentication token, and limit must be an integer when supplied. Pass the next_cursor value from response_metadata as cursor to retrieve the next page.

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.appsPermissionsResourcesList.list({
  token: "sk_live_4eC39Hq",
  cursor: "example",
  limit: 20,
});

{
  "ok": true,
  "resources": [
    {
      "id": "T0DES3UAN",
      "type": "team"
    },
    {
      "id": "D024BFF1M",
      "type": "app_home"
    },
    {
      "id": "C024BE91L",
      "type": "channel"
    }
  ],
  "response_metadata": {
    "next_cursor": "dGVhbTpDMUg5UkVTR0w="
  }
}

Request

Response

Errors