Group-related REST APIs

The ability to place users into groups with different permissions makes controlling a user's AnswerHub experience very simple. We designed this section to guide you in creating API requests that involve groups.

Documentation Related to Groups

📘

Note on groupIds:

  • You can find a group's groupId in the Administrator Console URL when you are on the Viewing Group: [group name] page. The ID is visible after /groups/. For example: https://apidocs.cloud.answerhub.com/admin/groups/6/view.html (The groupId in this example is 6).
  • You can also find a Group ID by making a request to retrieve a list of all the groups.

Group and GroupRequest Data Model

Field Summary

This table summarizes the fields supported by the group API requests:

Field Name

Type

Example(s)

Description

groupId

Integer

35

This is the integer (digit) formatted identifier for a group.

name

String

dev, "XBot1000"

This is the string formatted name of a group.

description

String

developers only group

This is where you can provide a description for a group.

GroupRequest Field Summary

The GroupRequest data model is similar to that of a group. The GroupRequest model excludes the groupId field.

Field Name

Type

Example(s)

Description

name

String

dev, "XBot1000"

This is the string formatted name of a group.

description

String

developers only group

This is where you can provide a description for a group.