Get a list of groups | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/groups \
     -H "Authorization: <apiKey>"

{
  "groups": [
    {
      "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"
    }
  ]
}

curl https://app.unleash-instance.example.com/api/admin/groups \
     -H "Authorization: <apiKey>"

{
  "groups": [
    {
      "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"
    }
  ]
}

Enterprise feature

Get a list of user groups for Role-Based Access Control

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

groupsSchema

groupslist of objects

A list of groups

Errors

401

Unauthorized Error

403

Forbidden Error

$	curl https://app.unleash-instance.example.com/api/admin/groups \
>	-H "Authorization: <apiKey>"

1	{
2	"groups": [
3	{
4	"name": "DX team",
5	"id": 1,
6	"description": "Current members of the DX squad",
7	"mappingsSSO": [
8	"SSOGroup1",
9	"SSOGroup2"
10	],
11	"rootRole": 1,
12	"createdBy": "admin",
13	"createdAt": "2023-06-30T11:41:00.123Z",
14	"users": [
15	{
16	"user": {
17	"id": 123,
18	"name": "User",
19	"email": "user@example.com",
20	"username": "hunter",
21	"imageUrl": "https://example.com/242x200.png",
22	"inviteLink": "http://localhost:4242/invite-link/some-secret",
23	"loginAttempts": 3,
24	"emailSent": false,
25	"rootRole": 1,
26	"seenAt": "2023-06-30T11:42:00.345Z",
27	"createdAt": "2023-06-30T11:41:00.123Z",
28	"accountType": "User",
29	"permissions": [
30	"string"
31	],
32	"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
33	"seatType": "Regular",
34	"companyRole": "Developer",
35	"productUpdatesEmailConsent": false,
36	"activeSessions": 2,
37	"deletedSessions": 1
38	},
39	"joinedAt": "2023-06-30T11:41:00.123Z",
40	"createdBy": "admin"
41	}
42	],
43	"projects": [
44	"default",
45	"my-project"
46	],
47	"userCount": 1,
48	"scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
49	}
50	]
51	}