The GET /users/{userId}/schedules endpoint gets a list of all schedules for the user matching the user ID provided.
| Panel | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Insert excerpt _ExcerptAPICloudNextGen _ExcerptAPICloudNextGen nopanel true
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 schedules
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/schedules" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain a list of all schedules for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success code and a collection of schedules.
Example response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"meta": {
"page": 1,
"count": 2,
"pageCount": 1,
"totalCount": 2
},
"userId": "d5b92547-5089-42ff-9e08-9293e96afcc0",
"agentDisplayId": "23456789",
"agentSchedules": [
{
"scheduleId": "d89e85d1-3452-4a80-913f-39de32fd864d",
"scheduleName": "Schedule1"
},
{
"scheduleId": "43e5fd40-b802-4001-9ec2-9f2393bb34a5",
"scheduleName": "Schedule2"
}
]
} |
where:
userId. The unique ID of the user.agentDisplayId. The agent's display ID.agentSchedules. The schedules assigned to the agent.scheduleId. The unique ID of the schedule.scheduleName. The name of the schedule.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true