/admin.usergroups.listChannels

GET

List the channels linked to an org-level IDP group (user group).

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://slack.com/api/admin.usergroups.listChannels?usergroup_id=' \
--header 'token;'

Response Example

200 - response

{
    "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

Query Params

usergroup_id

string

required

ID of the IDP group to list default channels for.

team_id

string

optional

ID of the the workspace.

include_num_members

string

optional

Flag to include or exclude the count of members per channel.

Header Params

token

string

required

Authentication token. Requires scope: admin.usergroups:read

Responses

🟢200Typical success response

application/json

Body

This method either only returns a brief _OK_ response or a verbose schema is not available for this method.

enum<boolean>

required

Allowed value:

true

Additional properties

integer | number | string | boolean

optional

🔴500Typical error response if the token provided is not associated with an Org Admin or Owner

Modified at 2023-08-15 05:39:45

/admin.usergroups.addTeams

/admin.usergroups.removeChannels