The GET /groups/{groupId}/users endpoint gets a list of all users in the group matching the group 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
groupId
Type | Required | Example |
|---|---|---|
| String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The group ID of the required group.
Requests
Request all users linked to a group
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/groups/8e22b1fe-d2ea-403d-8c03-50eb21188e79/users" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Responses
Responses contain the requested users.
Successful response
Successful requests return a 200 Success code and the requested users.
Example response
{
"meta": {
"page": 1,
"count": 2,
"pageCount": 1,
"totalCount": 2
},
"groupId": "4eb7422c-4a7a-4ed7-b02c-2dd72fee9f27",
"users": [
{
"userId": "ab94a5df-24cc-92aa-fb78-3b96fa6f5a39",
"agentDisplayId": "33000",
"name": "Supervisor"
},
{
"userId": "5d1fb056-6eae-09a7-3200-7e784f69d195",
"agentDisplayId": "33001",
"name": "Agent"
}
]
}
where:
users.userId. The unique ID of the user that is in the group.agentDisplayId. The ID of the agent who is in the group.name. The name of the user who is in the group.