usergroups.list.json

{
  "group": "usergroups",
  "name": "usergroups.list",
  "deprecated": false,
  "desc": "List all User Groups for a team",
  "args": {
    "include_count": {
      "required": false,
      "desc": "Include the number of users in each User Group.",
      "type": "boolean"
    },
    "include_disabled": {
      "required": false,
      "desc": "Include disabled User Groups.",
      "type": "boolean"
    },
    "include_users": {
      "required": false,
      "desc": "Include the list of users for each User Group.",
      "type": "boolean"
    },
    "team_id": {
      "required": false,
      "desc": "encoded team id to list user groups in, required if org token is used.",
      "type": "string"
    }
  },
  "response": {
    "examples": [
      "{\n    \"ok\": true,\n    \"usergroups\": [\n        {\n            \"id\": \"S0614TZR7\",\n            \"team_id\": \"T060RNRCH\",\n            \"is_usergroup\": true,\n            \"name\": \"Team Admins\",\n            \"description\": \"A group of all Administrators on your team.\",\n            \"handle\": \"admins\",\n            \"is_external\": false,\n            \"date_create\": 1446598059,\n            \"date_update\": 1446670362,\n            \"date_delete\": 0,\n            \"auto_type\": \"admin\",\n            \"created_by\": \"USLACKBOT\",\n            \"updated_by\": \"U060RNRCZ\",\n            \"deleted_by\": null,\n            \"prefs\": {\n                \"channels\": [],\n                \"groups\": []\n            },\n            \"user_count\": \"2\"\n        },\n        {\n            \"id\": \"S06158AV7\",\n            \"team_id\": \"T060RNRCH\",\n            \"is_usergroup\": true,\n            \"name\": \"Team Owners\",\n            \"description\": \"A group of all Owners on your team.\",\n            \"handle\": \"owners\",\n            \"is_external\": false,\n            \"date_create\": 1446678371,\n            \"date_update\": 1446678371,\n            \"date_delete\": 0,\n            \"auto_type\": \"owner\",\n            \"created_by\": \"USLACKBOT\",\n            \"updated_by\": \"USLACKBOT\",\n            \"deleted_by\": null,\n            \"prefs\": {\n                \"channels\": [],\n                \"groups\": []\n            },\n            \"user_count\": \"1\"\n        },\n        {\n            \"id\": \"S0615G0KT\",\n            \"team_id\": \"T060RNRCH\",\n            \"is_usergroup\": true,\n            \"name\": \"Marketing Team\",\n            \"description\": \"Marketing gurus, PR experts and product advocates.\",\n            \"handle\": \"marketing-team\",\n            \"is_external\": false,\n            \"date_create\": 1446746793,\n            \"date_update\": 1446747767,\n            \"date_delete\": 1446748865,\n            \"auto_type\": null,\n            \"created_by\": \"U060RNRCZ\",\n            \"updated_by\": \"U060RNRCZ\",\n            \"deleted_by\": null,\n            \"prefs\": {\n                \"channels\": [],\n                \"groups\": []\n            },\n            \"user_count\": \"0\"\n        }\n    ]\n}",
      "{\n    \"ok\": false,\n    \"error\": \"invalid_auth\"\n}"
    ]
  },
  "errors": {
    "plan_upgrade_required": "This workspace does not have access to User Groups, as that feature is only available on Standard and above plans.",
    "missing_argument": "A required argument is missing.",
    "not_authed": "No authentication token provided.",
    "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.",
    "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.",
    "token_expired": "Authentication token has expired.",
    "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.",
    "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.",
    "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
    "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.",
    "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.",
    "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."
  }
}