BLblackkitetech
Groups

Get the groups the credential creator can see.

Changed on

Returns the groups visible to the user who created this credential, with the members that same user would see on GET /api/v2/users, and the role assignments they can see. Requires the "User Access Management - Read" permission. When User Access Management for groups has not been enabled for the tenant, the call is rejected before groups are read.

get/api/v2/groups

Request

Query parameters

page_numberinteger
Example:1

The number of the page requested. Values below 1 are clamped to 1.

page_size10 | 20 | 30 | 50 | 100 | 250
Example:10

The number of result items in a single response. Allowed values are 10, 20, 30, 50, 100 and 250. Any other value is clamped to 10.

Response

A bare array. Field order is GroupId, Name, Description, CreatedDate, CreatedBy, NumberOfUsers, Users, RoleAssignments.

GroupIdinteger required

The id of the group.

Namestring required

The name of the group.

Descriptionstring required

A short description of the group.

CreatedDatestring date-time required

The date and time the group was created, in UTC.

CreatedBystring required

The user who created the group.

NumberOfUsersinteger required

The length of Users.

Example response

[
  {
    "GroupId": 7,
    "Name": "Ops",
    "Description": "Operations",
    "CreatedDate": "2026-01-02T03:04:05.000Z",
    "CreatedBy": "creator@example.com",
    "NumberOfUsers": 1,
    "Users": [
      {
        "UserId": "11",
        "FullName": "Ada Lovelace",
        "Email": "ada@example.com"
      }
    ],
    "RoleAssignments": [
      {
        "RoleId": 11,
        "RoleName": "Analyst",
        "AuthorizedEcosystems": [
          {
            "EcosystemId": 5,
            "EcosystemName": "Vendors"
          }
        ],
        "ExcludedEcosystems": [
          {
            "EcosystemId": 9,
            "EcosystemName": "Excluded"
          }
        ],
        "AuthorizedCompanies": [
          {
            "CompanyId": 70,
            "CompanyName": "Acme"
          }
        ]
      }
    ]
  }
]

Changes