GET/api/groups/{groupId}

Get a group

Retrieves a group by its unique identifier. Use groupId to select the group whose details you need.

1 parameter
groupIdstringrequired
The unique identifier of the group to retrieve.

5 status codes
200Returns the group object, including its ID, name, peer and resource counts, peers, and resources.
idstringrequired
Group ID
issuedstringoptional
How the group was issued (api, integration, jwt)
Allowed:apiintegrationjwt
namestringrequired
Group Name identifier
peers_countintegerrequired
Count of peers associated to the group
resources_countintegerrequired
Count of resources associated to the group
peersarray<object>required
List of peers object
resourcesarray<object>required
400Returned when the request is invalid.
401Returned when authentication is missing or invalid.
403Returned when the authenticated user is not permitted to retrieve the group.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when the request is invalid; a 401 is returned when authentication is missing or invalid; a 403 is returned when the authenticated user is not permitted to retrieve the group; and a 500 is returned when an internal server error occurs. The groupId path parameter must identify the group to retrieve.