Get a group

GET /api/2.0/group/{groupid}

Request

Returns the detailed information about the selected group: group name, category, description, manager, members, and parent group if it exists.

Note: This method returns full group information.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Path

groupidstringformat: uuid

Group ID

Examples

GET /api/2.0/group/%7Bgroupid%7D HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/group/%7Bgroupid%7D \
  --header 'Accept: application/json'

Responses

200

Group

Descriptionstring

Namestring

Parentarray of string

Categorystringformat: uuid

Idstringformat: uuid

Managerobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

Membersarray of object

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

401

Unauthorized