List an IDP group's default channels | Sample

4 parameters

usergroup_idstringrequired

Identifier of the IDP group whose default channels to list.

team_idstringoptional

Identifier of the workspace to scope the channel list to.

include_num_membersbooleanoptional

Boolean flag that controls whether member counts are included for each channel.

tokenstringrequired

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

2 status codes

200Returns an object with `ok` set to true and the requested IDP group channel information.

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 usergroup_id and a token with the admin.usergroups:read scope. Use team_id to identify the workspace to scope, and use include_num_members to control whether channel member counts are included.

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.adminUsergroupsListChannels.list({
  usergroupId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  teamId: "c0a80123-4567-89ab-cdef-0123456789ab",
  includeNumMembers: "example",
});

{
  "channels": [
    {
      "id": "C024BE91L",
      "name": "fun",
      "num_members": 34,
      "team_id": "T024BE911"
    },
    {
      "id": "C024BE91K",
      "name": "more fun",
      "team_id": "T024BE912"
    },
    {
      "id": "C024BE91M",
      "is_redacted": true,
      "name": "public-channel",
      "num_members": 34,
      "team_id": "T024BE911"
    },
    {
      "id": "C024BE91N",
      "name": "some more fun",
      "team_id": "T024BE921"
    }
  ],
  "ok": true
}

Request

Response

Errors