> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of User Groups

> Lists all the private groups/channels of the workspace.

Permission required: `view-room-administration`

### Changelog
| Version | Description                    |
| ------- | ------------------------------ |
|9.0.0   | Removed the `fields` and `query` parameters.       |
| 0.62.0  | Add 'query' parameter support. |
| 0.59.0  | Added                          |

## OpenAPI

````json GET /api/v1/groups.listAll
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Rooms"
  },
  "servers": [
    {
      "url": "https://apiexplorer.support.rocket.chat"
    }
  ],
  "tags": [
    {
      "name": "Channels"
    },
    {
      "name": "Directory"
    },
    {
      "name": "Groups"
    },
    {
      "name": "Rooms"
    },
    {
      "name": "Teams"
    },
    {
      "name": "Room Invites"
    },
    {
      "name": "Subscriptions"
    },
    {
      "name": "ABAC"
    }
  ],
  "paths": {
    "/api/v1/groups.listAll": {
      "get": {
        "tags": [
          "Groups"
        ],
        "summary": "Get List of User Groups",
        "description": "Lists all the private groups/channels of the workspace.\n\nPermission required: `view-room-administration`\n\n### Changelog\n| Version | Description                    |\n| ------- | ------------------------------ |\n|9.0.0   | Removed the `fields` and `query` parameters.       |\n| 0.62.0  | Add 'query' parameter support. |\n| 0.59.0  | Added                          |",
        "operationId": "get-api-v1-groups.listAll",
        "parameters": [
          {
            "$ref": "#/components/parameters/Auth-Token"
          },
          {
            "$ref": "#/components/parameters/UserId"
          },
          {
            "$ref": "#/components/parameters/offset"
          },
          {
            "$ref": "#/components/parameters/count"
          },
          {
            "$ref": "#/components/parameters/sort"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "groups": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "_id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "fname": {
                            "type": "string"
                          },
                          "t": {
                            "type": "string"
                          },
                          "msgs": {
                            "type": "integer"
                          },
                          "u": {
                            "type": "object",
                            "properties": {
                              "_id": {
                                "type": "string"
                              },
                              "username": {
                                "type": "string"
                              }
                            }
                          },
                          "customFields": {
                            "type": "object",
                            "properties": {
                              "companyId": {
                                "type": "string"
                              }
                            }
                          },
                          "ts": {
                            "type": "string"
                          },
                          "ro": {
                            "type": "boolean"
                          },
                          "sysMes": {
                            "type": "boolean"
                          },
                          "_updatedAt": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "offset": {
                      "type": "integer"
                    },
                    "count": {
                      "type": "integer"
                    },
                    "total": {
                      "type": "integer"
                    },
                    "success": {
                      "type": "boolean"
                    }
                  }
                },
                "examples": {
                  "Success": {
                    "value": {
                      "groups": [
                        {
                          "_id": "xA52DRDM7dqx2PfTp",
                          "name": "private1",
                          "fname": "private1",
                          "t": "p",
                          "msgs": 0,
                          "u": {
                            "_id": "3WpJQkDHhrWPBvXuW",
                            "username": "admin"
                          },
                          "customFields": {
                            "companyId": "org1"
                          },
                          "ts": "2018-01-21T21:05:06.729Z",
                          "ro": false,
                          "sysMes": true,
                          "_updatedAt": "2018-01-21T21:05:06.729Z"
                        }
                      ],
                      "offset": 0,
                      "count": 1,
                      "total": 1,
                      "success": true
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authorizationError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "Auth-Token": {
        "name": "X-Auth-Token",
        "in": "header",
        "description": "The `authToken` of the authenticated user.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "RScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f"
      },
      "UserId": {
        "name": "X-User-Id",
        "in": "header",
        "description": "The `userId` of the authenticated user.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "rbAXPnMktTFbNpwtJ"
      },
      "offset": {
        "name": "offset",
        "in": "query",
        "description": "Number of items to \"skip\" in the query, i.e. requests return count items, skipping the first offset items. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#pagination) to learn more.",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "example": 50
      },
      "count": {
        "name": "count",
        "in": "query",
        "description": "The number of items to return. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#pagination) to learn more.",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "example": 50
      },
      "sort": {
        "name": "sort",
        "in": "query",
        "description": "List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {\"value\": -1, \"_id\": 1}. Refer to the [official documentation](https://developer.rocket.chat/apidocs/query-parameters#pagination) to learn more.",
        "required": false,
        "schema": {}
      }
    },
    "responses": {
      "authorizationError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "success": {
                  "type": "boolean"
                },
                "error": {
                  "type": "string"
                }
              }
            },
            "examples": {
              "Authorization Error": {
                "value": {
                  "success": false,
                  "error": "You must be logged in to do this."
                }
              }
            }
          }
        }
      }
    }
  }
}
````