Get all skills
The GET /skills endpoint gets a list of all skills that the requestor has access to.
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 query parameters:
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 all skills
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/skills" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Request second page of skills
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/skills?page=2" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Responses
Responses contain a list of all skills that the requester has access to.
Successful response
Successful requests return a 200 Success code and a collection of skills.
Example response
{
"meta": {
"page": 1,
"count": 5,
"pageCount": 1,
"totalCount": 5
},
"skills": [
{
"skillId": "7e7ee25f-76fa-4ca8-94df-dae9c65d4df0",
"skillName": "Skill1",
"skillDisplayId": 12345
},
{
"skillId": "1a673164-5791-477c-a4fe-3f3364029166",
"skillName": "Skill2",
"skillDisplayId": 54321
},
{
"skillId": "f874d3d3-1fa6-4468-b7cb-666d4fe2c5d5",
"skillName": "Skill3",
"skillDisplayId": 32145
}
]
}
where:
skills. A collection of skills.skillId. The unique ID of the skill.skillName. The name of the skill.skillDisplayID. The skill's unique ID.
Try it out
For information, see Trying out Vonage Contact Center APIs.