---
title: "Get a single group"
method: GET
path: "/api/admin/groups/{groupId}"
tags: ["Users"]
---

# Get a single group

`GET /api/admin/groups/{groupId}`

**Enterprise feature**

Get a single user group by group id

## Path parameters

- `groupId` string, required

## Response `200`

groupSchema

- GroupSchema — A detailed information about a user group
  - `id` integer — The group id
  - `name` string, required — The name of the group
  - `description` string, nullable — A custom description of the group
  - `mappingsSSO` string[] — A list of SSO groups that should map to this Unleash group
  - `rootRole` number, nullable — A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.
  - `createdBy` string, nullable — A user who created this group
  - `createdAt` string, date-time, nullable — When was this group created
  - `users` GroupUserModelSchema[] — A list of users belonging to this group
    - `joinedAt` string, date-time — The date when the user joined the group
    - `createdBy` string, nullable — The username of the user who added this user to this group
    - `user` UserSchema, required — An Unleash user
      - `id` integer, required — The user id
      - `name` string, nullable — Name of the user
      - `email` string — Email of the user
      - `username` string, nullable — A unique username for the user
      - `imageUrl` string — URL used for the user profile image
      - `inviteLink` string — If the user is actively inviting other users, this is the link that can be shared with other users
      - `loginAttempts` integer — How many unsuccessful attempts at logging in has the user made
      - `emailSent` boolean — Is the welcome email sent to the user or not
      - `rootRole` integer — Which [root role](https://docs.getunleash.io/concepts/rbac#predefined-roles) this user is assigned
      - `seenAt` string, date-time, nullable — The last time this user logged in
      - `createdAt` string, date-time — The user was created at this time
      - `accountType` 'User' | 'Service Account' — A user is either an actual User or a Service Account
      - `permissions` string[] — Deprecated
      - `scimId` string, nullable — The SCIM ID of the user, only present if managed by SCIM
      - `seatType` string, nullable — The seat type of this user
      - `companyRole` string, nullable — The role of the user within the company.
      - `productUpdatesEmailConsent` boolean, nullable — Whether the user has consented to receive product update emails.
      - `activeSessions` integer, nullable — Count of active browser sessions for this user
      - `deletedSessions` number — Experimental. The number of deleted browser sessions after last login
  - `projects` string[] — A list of projects where this group is used
  - `userCount` integer — The number of users that belong to this group
  - `scimId` string, nullable — The SCIM ID of the group, only present if managed by SCIM

## Other responses

- `400` — The request data does not match what we expect.
- `401` — Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
- `403` — The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- `404` — The requested resource was not found.

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/versions/b2c3116e633e/schema)