List pending workspace invite requests

4 parameters

team_idstringoptional

The identifier of the workspace whose pending invite requests to list.

cursorstringoptional

The `next_cursor` value returned by the previous response to retrieve the next page.

limitintegeroptional

The number of results to return per request. Must be between 1 and 1000 inclusive.

tokenstringrequired

Authentication token with the `admin.invites:read` scope.

2 status codes

200Returns a successful response containing the pending workspace invite request results with `ok` set to true.

okbooleanrequired

Allowed:true

defaultReturns the standard failure response with `ok` set to false.

okbooleanrequired

Allowed:false

Error handling

token must carry the admin.invites:read scope. limit must be between 1 and 1000 inclusive when provided, and cursor must contain the next_cursor value from the previous response when continuing pagination.

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.adminInviteRequestsList.list({
  teamId: "c0a80123-4567-89ab-cdef-0123456789ab",
  cursor: "example",
  limit: 20,
});

{
  "ok": true
}

Request

Response

Errors