Get skill's users
The GET /skills/{skillId}/users endpoint gets a list of users with the skill matching the skill ID provided.
In this page
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
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 path parameter:
skillId
Type | Required | Example |
|---|---|---|
| String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The skill ID of the required skill.
Requests
Request all users linked to a skill
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/skills/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": 5,
"pageCount": 1,
"totalCount": 5
},
"users": [
{
"userId": "c7705a71-dac7-411f-8a7a-d1c6473334cc",
"agentDisplayId": "5896",
"name": "User1",
"agentSkillLevel": 5
},
{
"userId": "993e6114-ea84-250b-eb68-df4a4a7808bd",
"agentDisplayId": "33003",
"name": "User2",
"agentSkillLevel": 5
},
{
"userId": "8e25ac09-7620-f24f-a19a-3cdb5054a869",
"agentDisplayId": "86001",
"name": "User3",
"agentSkillLevel": 5
}
],
}
where:
users.userId. The unique ID of the user that has the skill.agentDisplayId. The ID of the agent who has the skill.name. The name of the user who has the skill.agentSkillLevel. The agent’s skill level.
Try it out
For information, see Trying out Vonage Contact Center APIs.