Overview
You can use this API request to retrieve detailed information about a group.
Information
You can use the following parameters in your retrieve group information request:
Projection: include, exclude, includeOnly
Other options: wrap, v1
Permissions & Notes:
-
You must have the Edit users and groups permission under Site Administration Roles in the Advanced Editor.
-
With the includeOnly parameter set to id and name (/services/v2/group.json?includeOnly=id,name) to the AnswerHub REST API.
- We added this request in version 1.6.3.
A GET retrieve group information request to retrieve information for a group (groupId: 3) sent to https://apidocs.cloud.answerhub.com using a human-readable Username/Password (answerhub/test123) would look like this:
- cURL
curl
-u answerhub:test123
-H "Accept: application/json"
-H "Content-type: application/json"
-X GET "https://apidocs.cloud.answerhub.com/services/v2/group/3.json"
curl
-u answerhub:test123
-H "Accept: application/json"
-H "Content-type: application/json"
-X GET "https://apidocs.cloud.answerhub.com/services/v2/group/3.json"Successful Response
- Sample Formatted JSON Response
{
"id": 3,
"type": "group",
"creationDate": 1542778947000,
"creationDateFormatted": "11/21/2018 05:42 AM",
"modificationDate": 1547066915000,
"name": "Users"
}
{
"id": 3,
"type": "group",
"creationDate": 1542778947000,
"creationDateFormatted": "11/21/2018 05:42 AM",
"modificationDate": 1547066915000,
"name": "Users"
}Error Response
500 Internal Server Error
- JSON
{
"errors": {
"message": "Internal server error"
}
}
{
"errors": {
"message": "Internal server error"
}
}
Priyanka Bhotika
Comments