List workspace administrators | Sample

4 parameters

tokenstringrequired

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

limitintegeroptional

The maximum number of administrators to return.

cursorstringoptional

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

team_idstringrequired

The identifier of the workspace whose administrators to list.

2 status codes

200Returns a successful response containing the workspace administrator 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.teams:read scope, and team_id must identify the workspace whose administrators you want to list. When supplied, cursor must be the next_cursor value from the previous response; limit controls the maximum number of items returned.

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

{
  "admin_ids": [
    "U1234"
  ],
  "ok": true
}

Request

Response

Errors