List Enterprise organization teams | Sample

3 parameters

limitintegeroptional

The maximum number of teams to return. Must be between 1 and 100 inclusive.

cursorstringoptional

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

tokenstringrequired

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

2 status codes

200Returns a successful response containing the Enterprise organization team 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. When provided, limit must be between 1 and 100 inclusive, and cursor must contain the next_cursor value from the previous response to continue listing teams.

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

{
  "ok": true,
  "teams": [
    {
      "discoverability": "hidden",
      "id": "T1234",
      "name": "My Team",
      "primary_owner": {
        "email": "bront@slack.com",
        "user_id": "W1234"
      },
      "team_url": "https://subarachnoid.slack.com/"
    }
  ]
}

Request

Response

Errors