GET
/
organizations
/
{organization}
/
groups
/
{groupName}
curl --request GET \
  --url https://cloud.local.wirtual.dev/api/v2/organizations/{organization}/groups/{groupName} \
  --header 'Wirtual-Session-Token: <api-key>'
{
  "avatar_url": "<string>",
  "display_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "members": [
    {
      "avatar_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_seen_at": "2023-11-07T05:31:56Z",
      "login_type": "",
      "name": "<string>",
      "status": "<any>",
      "theme_preference": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "username": "<string>"
    }
  ],
  "name": "<string>",
  "organization_display_name": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_name": "<string>",
  "quota_allowance": 123,
  "source": "user",
  "total_member_count": 123
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
organization
string
required

Organization ID

​
groupName
string
required

Group name

Response

200 - application/json
OK
​
avatar_url
string
​
display_name
string
​
id
string
​
members
object[]
​
name
string
​
organization_display_name
string
​
organization_id
string
​
organization_name
string
​
quota_allowance
integer
​
source
enum<string>
Available options:
user,
oidc
​
total_member_count
integer

How many members are in this group. Shows the total count, even if the user is not authorized to read group member details. May be greater than len(Group.Members).