API method

admin.usergroups.listChannels

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

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/admin.usergroups.listChannels
Bolt for Java
app.client().adminUsergroupsListChannels
Powered by Bolt
Bolt for Python
app.client.admin_usergroups_listChannels
Powered by Bolt
Bolt for JavaScript
app.client.admin.usergroups.listChannels
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 2
  • Arguments

    ArgumentTypeDescription
    tokenRequired

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Examplexxxx-xxxxxxxxx-xxxx
    usergroup_idRequired

    ID of the IDP group to list default channels for.

    ExampleS00000000
    include_num_members
    boolean

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

    Exampletrue
    team_id
    string

    ID of the the workspace.

    ExampleT00000000

    This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

    Example responses

    Common successful response

    Typical success response

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

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

    {
        "ok": false,
        "error": "not_an_admin"
    }

    This API method for admins may only be used on Enterprise Grid.

    This method's response is limited to the channels that the requesting token (and thus, the installing Org Admin or Owner) can see.

    Errors

    This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

    ErrorDescription
    feature_not_enabled

    The Admin APIs feature is not enabled for this workspace.

    not_an_admin

    The token provided is not associated with an Org Admin or Owner.

    invalid_user

    The calling user is not valid.

    not_allowed

    The calling user is not an admin or does not have necessary role

    not_an_enterprise

    The token passed in does not belong to an Enterprise organization.

    usergroup_not_found

    The IDP group provided was not found.

    usergroup_not_linked_to_team

    The IDP group provided is not linked to the specified workspace.

    team_not_found

    The workspace was not found.

    invalid_auth

    Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

    not_authed

    No authentication token provided.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    token_revoked

    Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

    no_permission

    The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

    org_login_required

    The workspace is undergoing an enterprise migration and will not be available until migration is complete.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    not_allowed_token_type

    The token type used in this request is not allowed.

    method_deprecated

    The method has been deprecated.

    deprecated_endpoint

    The endpoint has been deprecated.

    two_factor_setup_required

    Two factor setup is required.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    is_bot

    This method cannot be called by a bot user.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.

    invalid_arg_name

    The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

    invalid_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    invalid_charset

    The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

    invalid_form_data

    The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

    invalid_post_type

    The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

    missing_post_type

    The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

    team_added_to_org

    The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

    invalid_json [hidden]The method was called via a `POST` request with `Content-Type` `application/json`, but the body was not valid JSON.
    json_not_object [hidden]The method was called via a `POST` request a valid JSON body, but the JSON value was not an object.
    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    accesslimited

    Access to this method is limited on the current network

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    upgrade_required [hidden]The calling application needs to be upgraded.
    service_unavailable

    The service is temporarily unavailable

    fatal_error

    The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

    internal_error

    The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

    Warnings

    This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response

    Was this page helpful?