# Get All Subgroups of a User Group

## Request

```CURL
GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/usergroups/user group id/subgroups?fields=string&amp;$skip=int&amp;$top=int&amp;query=string&amp;orderBy=string
```

|  Parameter  |  Description  |
| --- | --- |
|  `fields`  |  Optional. Returns only the specified subset of the fields for each Subgroup. Use [Fields Syntax](hub-api-fields-syntax.html) to define the subset.  |
|  `$skip`  |  Optional. Lets you set a number of Subgroups to skip before returning the first one.  |
|  `$top`  |  Optional. Lets you set the maximum number of Subgroups to return.  |
|  `query`  |                            Optional. Lets you specify a search query to filter the returned results. See [Query Syntax](hub-api-query-syntax.html) for the definition of supported logical operations syntax. For the Subgroups, the following fields and tuples are supported:     access(project: project, with: role) — Groups that have the given role in the given project      access(project: project, with: permission) — Groups that have the given permission in the given project      access(project: project) — Groups that have some role in the given project      access(with: role) — Groups that have the given role assigned anywhere      access(with: permission) — Groups that have the given permission granted anywhere      has: ownRole — Groups with own roles      has: user — Groups with users      has: subgroup — Groups with subgroups      has: icon — Groups with an icon      id: value — Group with the given ID      is: allUsers — All users group      is: registeredUsers — Registered users group      is: autoJoin — Groups with enabled auto join      is: required2FA — Groups with required two-factor authentication      is: removedFromIdp — Groups that have been removed from Identity Provider      name: groupName — Group with the given name      ownRole: role — Groups that have the given role as an own role      parent: group — Subgroups of the given group      project: project — Groups from the given project      subgroup: group — Group that contains the given group as subgroup      user: user — Groups that immediately contain the given user     |
|  `orderBy`  |  Optional. Returns the list of Subgroups sorted by a specified field. See [Sorting Syntax](hub-api-sort-syntax.html) for details. Subgroups support ordering by the following fields: name  |

## Response

|  Response Code  |  Meaning  |
| --- | --- |
|  200 OK  |  Successful request.  |
|  400 Bad Request  |  At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.  |
|  403 Forbidden  |  The requester has no access to the requested resource.  |
|  404 Not Found  |  The requested resource was not found.  |
|  500 Internal Server Error  |  Failed to process request because of the server error. For details, check the error message in the response.  |

### Response body

```JSON
{
  "skip": int, 
  "top": int, 
  "total": int, 
  "subgroups": [[[[userGroup|HUB-REST-API_JSON-Scheme.html#userGroup]]], ...]
}
```