List app user grants | Sample

3 parameters

tokenstringrequired

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

cursorstringoptional

Pagination cursor from a previous response; omit it to retrieve the first page.

limitintegeroptional

Maximum number of user grants to return.

2 status codes

200Returns a successful response with `ok` set to true.

okbooleanrequired

Allowed:true

defaultReturned when the request cannot be completed; the response contains `ok` set to false.

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 the previous response as cursor to continue through the collection.

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

{
  "ok": true,
  "resources": [
    {
      "id": "U0DES3UAN",
      "scopes": [
        "dnd:write:user",
        "reminders:write:user"
      ]
    },
    {
      "id": "U024BFF1M",
      "scopes": [
        "reminders:write:user"
      ]
    }
  ],
  "response_metadata": {
    "next_cursor": "dGVhbTdPMUg5UkFTT0w="
  }
}

Request

Response

Errors