Retrieve Group Information

You can use this API request to retrieve detailed information about a group.

/services/v2/group/[groupId].json

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.

Sample Request

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 
-u answerhub:test123 
-H "Accept: application/json" 
-H "Content-type: application/json" 
-X GET "https://apidocs.cloud.answerhub.com/services/v2/group/3.json"

Sample Responses

Successful Response

{
    "id": 3,
    "type": "group",
    "creationDate": 1542778947000,
    "creationDateFormatted": "11/21/2018 05:42 AM",
    "modificationDate": 1547066915000,
    "name": "Users"
}

Error Response
500 Internal Server Error

{
    "errors": {
        "message": "Internal server error"
    }
}
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!