> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getunleash.io/api/get-group/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getunleash.io/_mcp/server.

# Get a single group

GET https://app.unleash-instance.example.com/api/admin/groups/{groupId}

**Enterprise feature**

Get a single user group by group id

Reference: https://docs.getunleash.io/api/get-group

## Authentication

- `Authorization` header (required) — API key needed to access this API
- `Authorization` header (bearer token, required) — API key needed to access this API, in Bearer token format

## Request

### Path parameters

- `groupId` (string, required)

## Response

### 200

groupSchema

- `name` (string, required) — The name of the group
- `id` (integer, optional) — The group id
- `description` (string, optional, nullable) — A custom description of the group
- `mappingsSSO` (list of string, optional) — A list of SSO groups that should map to this Unleash group
- `rootRole` (double, optional, 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, optional, nullable) — A user who created this group
- `createdAt` (string, optional, nullable) — When was this group created
- `users` (list of groupUserModelSchema, optional) — A list of users belonging to this group
- `projects` (list of string, optional) — A list of projects where this group is used
- `userCount` (integer, optional) — The number of users that belong to this group
- `scimId` (string, optional, nullable) — The SCIM ID of the group, only present if managed by SCIM

## Errors

### 400 Bad Request Error

The request data does not match what we expect.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 401 Unauthorized Error

Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 403 Forbidden Error

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 404 Not Found Error

The requested resource was not found.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

## Types

### groupUserModelSchema

Details for a single user belonging to a group

- `user` (userSchema, required) — An Unleash user
- `joinedAt` (string, optional) — The date when the user joined the group
- `createdBy` (string, optional, nullable) — The username of the user who added this user to this group

### userSchema

An Unleash user

- `id` (integer, required) — The user id
- `name` (string, optional, nullable) — Name of the user
- `email` (string, optional) — Email of the user
- `username` (string, optional, nullable) — A unique username for the user
- `imageUrl` (string, optional) — URL used for the user profile image
- `inviteLink` (string, optional) — If the user is actively inviting other users, this is the link that can be shared with other users
- `loginAttempts` (integer, optional) — How many unsuccessful attempts at logging in has the user made
- `emailSent` (boolean, optional) — Is the welcome email sent to the user or not
- `rootRole` (integer, optional) — Which [root role](https://docs.getunleash.io/concepts/rbac#predefined-roles) this user is assigned
- `seenAt` (string, optional, nullable) — The last time this user logged in
- `createdAt` (string, optional) — The user was created at this time
- `accountType` (enum, optional) — A user is either an actual User or a Service Account
  - Allowed values: `User`, `Service Account`
- `permissions` (list of string, optional) — Deprecated
- `scimId` (string, optional, nullable) — The SCIM ID of the user, only present if managed by SCIM
- `seatType` (string, optional, nullable) — The seat type of this user
- `companyRole` (string, optional, nullable) — The role of the user within the company.
- `productUpdatesEmailConsent` (boolean, optional, nullable) — Whether the user has consented to receive product update emails.
- `activeSessions` (integer, optional, nullable) — Count of active browser sessions for this user
- `deletedSessions` (double, optional) — Experimental. The number of deleted browser sessions after last login

## Examples

**Response**

```json
{
  "name": "DX team",
  "id": 1,
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "createdBy": "admin",
  "createdAt": "2023-06-30T11:41:00.123Z",
  "users": [
    {
      "user": {
        "id": 123,
        "name": "User",
        "email": "user@example.com",
        "username": "hunter",
        "imageUrl": "https://example.com/242x200.png",
        "inviteLink": "http://localhost:4242/invite-link/some-secret",
        "loginAttempts": 3,
        "emailSent": false,
        "rootRole": 1,
        "seenAt": "2023-06-30T11:42:00.345Z",
        "createdAt": "2023-06-30T11:41:00.123Z",
        "accountType": "User",
        "permissions": [
          "string"
        ],
        "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
        "seatType": "Regular",
        "companyRole": "Developer",
        "productUpdatesEmailConsent": false,
        "activeSessions": 2,
        "deletedSessions": 1
      },
      "joinedAt": "2023-06-30T11:41:00.123Z",
      "createdBy": "admin"
    }
  ],
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}
```

**SDK Code**

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/groups/groupId"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/groups/groupId';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/groups/groupId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/groups/groupId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.unleash-instance.example.com/api/admin/groups/groupId")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.unleash-instance.example.com/api/admin/groups/groupId', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/groups/groupId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/groups/groupId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```