The GET
/users/{userId}/permissions/queues
endpoint gets a list of all queue permissions for the user matching the user ID provided.
...
Authorization scopes supported:
Scope | Access granted |
---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
Parameters
The endpoint accepts the following query parameters:
...
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 a list of queue permissions for the user
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/queues" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain a list of all queue permissions for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success
code and a collection of queue permissions.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "meta": { "page": 1, "count": 1, "pageCount": 1, "totalCount": 1 }, "queues": [ { "queueId": "e988914d-711a-4f32-9acf-5df26670333d", "queueName": "queue1", "interactionPlanId": "9b94c6f4-6d3b-4806-9959-5e751d7bfdb9", "queuePermission": "Read" } ] } |
where:
userId
. The unique ID of the user.queues
. The user’s queue permissions.queueId
. The user’s queue permissions that the user has access to.queueName
. The name of the queue that the user has access to.interactionPlanId
. The unique ID of the interaction plan.queuePermission
. Access levels for accessing resources such as Queues. Possible values: None, Read, Write.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true