---
title: "Returns a paged list of user groups."
method: GET
path: "/gdc/userGroups"
tags: ["user-groups"]
---

# Returns a paged list of user groups.

`GET /gdc/userGroups`

## Request

- Base URL: `https://secure.gooddata.com`
- URL: `https://secure.gooddata.com/gdc/userGroups`
- Auth: none declared. Required headers: `Accept`

You can specify both filtering and paging. Use only the following filter combinations:


 + `project` - List all groups for this project.


 + `project` + `user` - List groups that this user is belongs to for this project. 
 The user must be part of the project.


 + `project` + `userGroup` - List groups that this user group belongs to for this project. 
 The user group must be part of the project.

## Query parameters

- `user` string
- `project` string
- `userGroup` string
- `includeImplicit` boolean
- `includeIndirect` boolean
- `includeParent` boolean
- `uriOnly` boolean
- `offset` string
- `limit` integer

## Headers

- `Accept` string, required

## Response `200`

List of user groups fulfilling criteria successfully returned

- union
  - PagedListOfUserGroups
    - `userGroups` object, required
      - `paging` PagingWithOffsetAndLimit, required
        - `offset` string, nullable, required
        - `limit` integer, required
        - `next` string, uri, nullable, required: URL of the next page
      - `items` UserGroup[], required: _
        - `userGroup` object, required
          - `content` UserGroupContent, required
            - `name` string, required
            - `id` string, nullable: Id of the user group is ignored in POST, as it is not known.
            - `description` string, nullable
            - `domain` union: Deprecated, value ignored. It is here because of backward compatibility.
              - …
            - `project` string, uri, nullable: Can not be changed in PUT. Has to be specified.
          - `meta` UserGroupMeta: User group metainformation is ignored in write operations.
            - `created` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss`
            - `updated` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss`
          - `links` UserGroupLinks
            - `self` string, required: URI of the user group
            - `members` string, uri, required
            - `modifyMembers` string, uri, required
  - PagedListOfUserGroupUris
    - `uris` object, required
      - `paging` PagingWithOffsetAndLimit, required
        - `offset` string, nullable, required
        - `limit` integer, required
        - `next` string, uri, nullable, required: URL of the next page
      - `items` string[], required

## Other responses

- `400`: The API call failed due to invalid parameters. Check the response for details.
- `403`: The API call failed because you do not have persmission to display informations about user groups and their members ("UserGroupReadPermission").
- `default`: Common error

---

[API](https://skmtc.dev/gooddata/apis/gooddata-api-documentation.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/revisions/e5dc0ee6ab00?raw)