List users in a workspace | Sample

4 parameters

team_idstringrequired

Identifier of the workspace whose users to list.

cursorstringoptional

Cursor from the previous response's `next_cursor` value for retrieving the next page.

limitintegeroptional

Integer limiting the number of users to retrieve per page.

tokenstringrequired

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

2 status codes

200Returns an object with `ok` set to true and the requested page of workspace users.

okbooleanrequired

Allowed:true

defaultReturns an object with `ok` set to false when the request cannot be completed.

okbooleanrequired

Allowed:false

Error handling

The request must include team_id and a token with the admin.users:read scope. Use cursor only with a value returned in next_cursor, and use limit to control the number of users retrieved per 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.adminUsersList.list({
  teamId: "c0a80123-4567-89ab-cdef-0123456789ab",
  cursor: "example",
  limit: 20,
});

{
  "ok": true,
  "users": [
    {
      "email": "bront@slack.com",
      "id": "T1234",
      "is_admin": false,
      "is_bot": false,
      "is_owner": false,
      "is_primary_owner": false,
      "is_restricted": false,
      "is_ultra_restricted": false
    }
  ]
}

Request

Response

Errors