Skip to main content
GET
/
v1
/
groups
/
{group}
cURL
curl --request GET \
  --url https://api.example.com/v1/groups/{group}
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "members": [
    {
      "member": "<string>",
      "role": "ROLE_UNSPECIFIED"
    }
  ],
  "source": "<string>",
  "email": "<string>"
}

Path Parameters

​
group
string
required

The group id.

Response

OK

A group of users within the workspace.

​
name
string

The name of the group to retrieve. Format: groups/{group}, the group should be email or uuid.

​
title
string

The display title of the group.

​
description
string

The description of the group.

​
members
object[]

The members of the group.

​
source
string

The source system where the group originated (e.g., Entra ID for SCIM sync).

​
email
string

The unique email for the group.