The GET /users/{userId}/groups endpoint gets a list of all groups for the user matching the user ID provided.
In this page
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
Parameters
The endpoint accepts the following query parameters:
userID
Type | Required | Example |
|---|---|---|
| String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
limit
Type | Required | Example |
|---|---|---|
| integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
|---|---|---|
| integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Requests
Request user's linked groups
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/groups" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Responses
Responses contain a list of all groups for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success code and a collection of groups.
Example response
{
"meta": {
"page": 1,
"count": 3,
"pageCount": 1,
"totalCount": 3
},
"userId": "2e112b55-abf7-4ae3-b737-517d0d01513f",
"agentDisplayId": "9876",
"agentGroups": [
{
"groupId": "b71db70d-287b-4478-ac04-9557be0f82b2",
"groupDisplayId": "1122",
"groupName": "Group1"
},
{
"groupId": "c5cef79b-2fad-4316-be1f-e2003d592ffb",
"groupDisplayId": "1133",
"groupName": "Group2"
},
{
"groupId": "ad1935ca-736c-4227-be30-dad9fdd5406b",
"groupDisplayId": "1155",
"groupName": "Group3"
}
]
}
where:
userId. The unique ID of the user.agentDisplayId. The agent's unique ID.agentGroups. The groups that the agent is in.groupId. The unique ID of the group.groupDisplayID. The group's unique ID.groupName. The name of the group.