Skip to main content

usergroups.list method

Facts​

DescriptionList all User Groups for a team.
Method Access
GET https://slack.com/api/usergroups.list
Scopes
Bot token:
User token:
Content types
application/x-www-form-urlencoded
application/json
Rate LimitsTier 2: 20+ per minute

Arguments​

Required arguments

tokenstringRequired

Optional arguments

include_countbooleanOptional

Include the number of users in each User Group.

Example: true
include_disabledbooleanOptional

Include results for disabled User Groups.

Example: true
include_usersbooleanOptional

Include the list of users for each User Group.

Example: true
team_idOptional

The user group's encoded team ID. Required if org token is used.

Usage info​

This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.

The team_id is only relevant when using an org-level token. This field will be ignored if the API call is sent using a workspace-level token.

Response​

Returns a list of usergroup objects, in no particular order.

Typical success response

{
  "ok": true,
  "usergroups": [
    {
      "id": "S0614TZR7",
      "team_id": "T060RNRCH",
      "is_usergroup": true,
      "name": "Team Admins",
      "description": "A group of all Administrators on your team.",
      "handle": "admins",
      "is_external": false,
      "date_create": 1446598059,
      "date_update": 1446670362,
      "date_delete": 0,
      "auto_type": "admin",
      "created_by": "USLACKBOT",
      "updated_by": "U060RNRCZ",
      "deleted_by": null,
      "prefs": {
        "channels": [],
        "groups": []
      },
      "user_count": "2"
    },
    {
      "id": "S06158AV7",
      "team_id": "T060RNRCH",
      "is_usergroup": true,
      "name": "Team Owners",
      "description": "A group of all Owners on your team.",
      "handle": "owners",
      "is_external": false,
      "date_create": 1446678371,
      "date_update": 1446678371,
      "date_delete": 0,
      "auto_type": "owner",
      "created_by": "USLACKBOT",
      "updated_by": "USLACKBOT",
      "deleted_by": null,
      "prefs": {
        "channels": [],
        "groups": []
      },
      "user_count": "1"
    },
    {
      "id": "S0615G0KT",
      "team_id": "T060RNRCH",
      "is_usergroup": true,
      "name": "Marketing Team",
      "description": "Marketing gurus, PR experts and product advocates.",
      "handle": "marketing-team",
      "is_external": false,
      "date_create": 1446746793,
      "date_update": 1446747767,
      "date_delete": 1446748865,
      "auto_type": null,
      "created_by": "U060RNRCZ",
      "updated_by": "U060RNRCZ",
      "deleted_by": null,
      "prefs": {
        "channels": [],
        "groups": []
      },
      "user_count": "0"
    }
  ]
}

Typical error response

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

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 parameter in the response.

Error
Description
access_denied

Access to a resource specified in the request is denied.

accesslimited

Access to this method is limited on the current network

account_inactive

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

deprecated_endpoint

The endpoint has been deprecated.

ekm_access_denied

Administrators have suspended the ability to post a message.

enterprise_is_restricted

The method cannot be called from an Enterprise.

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.

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_arguments

The method was called with invalid arguments.

invalid_array_arg

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

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.

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_cursor

Value passed for cursor was not valid or is no longer valid.

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.

invalid_team

Cannot find subteam team.

method_deprecated

The method has been deprecated.

missing_argument

A required argument is missing.

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.

missing_scope

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

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.

not_allowed_token_type

The token type used in this request is not allowed.

not_authed

No authentication token provided.

org_login_required

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

plan_upgrade_required

This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.

ratelimited

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

request_timeout

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

service_unavailable

The service is temporarily unavailable

team_access_not_granted

The token used is not granted the specific workspace access required to complete this request.

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.

token_expired

Authentication token has expired

token_revoked

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

two_factor_setup_required

Two factor setup is required.

users_not_found

Cannot find users on subteam.