GET Group details

Overview

The Group Details endpoint returns information about a group. A valid group UUID is required. A group href returned by another endpoint corresponds to the Group Details endpoint.

Base path

/api/v1/groups/GROUP_UUID

Path parameters

GROUP_UUID

(string) The unique identifier for a group.

Curl example

curl -X GET \
'https://API_HOSTNAME/api/v1/groups/GROUP_UUID \
--header 'Authorization: Bearer BEARER_TOKEN'

Response

The response is a group.

Response body

{
    "uuid": "GROUP_UUID",
    "name": "My Group",
    "parent": {
        "href": "/api/v1/groups/GROUP_UUID",
        "title": "Parent Group"
    }
}

Result attributes

uuid

(string) A unique identifier for the group.

parent

(link) A reference to the parent of the group, if a parent exists and if the client has permission to read it.

name

(string) The name of the group.