---
title: "View an individual User Group details"
method: GET
path: "/usergroups/{id}"
tags: ["User Groups"]
---

# View an individual User Group details

`GET /usergroups/{id}`

## Request

- Base URL: `https://console.jumpcloud.com/api/v2`
- URL: `https://console.jumpcloud.com/api/v2/usergroups/{id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/usergroups/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint returns the details of a User Group.

#### Sample Request
```
curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

## Headers

- `x-org-id` string

## Response `200`

OK

- UserGroup
  - `attributes` GroupAttributesUserGroup, nullable: The graph attributes for a UserGroup.
    - `sudo` object, nullable
      - `enabled` boolean, required: Enables sudo
      - `withoutPassword` boolean, required: Enable sudo without password (requires 'enabled' to be true)
    - `ldapGroups` LdapGroup[]
      - `name` string
    - `posixGroups` object[]
      - `id` integer, required
      - `name` string, required
    - `radius` object, nullable
      - `reply` object[]
        - `name` string, required
        - `value` string, required
    - `sambaEnabled` boolean
  - `email` string: Email address of a User Group
  - `description` string: Description of a User Group
  - `id` string: ObjectId uniquely identifying a User Group.
  - `memberQuery` MemberQuery, nullable: Dynamic group member query. v1 (default): include queryType (FilterQuery, Filter, or Search). v2 (x-query-dsl: v2): omit queryType; filters use field, operation, and value.
    - `queryType` 'Filter' | 'FilterQuery' | 'Search': Required for v1 member queries (default when the x-query-dsl header is omitted or set to v1). Omit for v2 member queries (x-query-dsl: v2).
    - `filters` unknown[]
      - unknown
  - `memberQueryExemptions` MemberQueryExemption[]: Array of GraphObjects exempted from the query
    - `id` string, required: The ObjectID of the exempted graph object.
    - `organizationId` string: The organization that owns the exempted object, when known.
    - `type` string, required: The type of graph object.
  - `memberSuggestionsNotify` boolean: True if notification emails are to be sent for membership suggestions.
  - `memberQueryErrorFlags` string[]: Group error flags indicating errors encountered during member query evaluation. Possible flag values: - CYCLE: A cyclic dependency was detected in group membership - INVALID_GROUP_REFERENCE: The group reference is invalid or does not exist The `member_query_error_flags` as a field supports array-based filtering: - `CO`: Contains Overlap - check if array overlaps with the specified array (use `["VALUE"]` for single value) - `NCO`: Not Contains Overlap - check if array does not overlap - `EQ`: Exact array match - `NE`: Not equal to array - `IN`: Array contains any of the specified values **Note:** Single `value` is converted to array `["value"]``.
  - `membershipMethod` 'NOTSET' | 'STATIC' | 'DYNAMIC_REVIEW_REQUIRED' | 'DYNAMIC_AUTOMATED': The type of membership method for this group. Valid values include NOTSET, STATIC, DYNAMIC_REVIEW_REQUIRED, and DYNAMIC_AUTOMATED. Note DYNAMIC_AUTOMATED and DYNAMIC_REVIEW_REQUIRED group rules will supersede any group enrollment for [group-associated MDM-enrolled devices](https://jumpcloud.com/support/change-a-default-device-group-for-apple-devices). Use caution when creating dynamic device groups with MDM-enrolled devices to avoid creating conflicting rule sets.
  - `name` string: Display name of a User Group.
  - `organizationObjectId` string, nullable: id of the organization owning this group
  - `suggestionCounts` SuggestionCounts
    - `add` integer
    - `remove` integer
    - `total` integer
  - `type` 'user_group': The type of the group.

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/revisions/3f09fe63caaa?raw)