The GET /users/{userId}/permissions/addresses
endpoint gets a list of all address permissions for the user matching the user ID provided.
...
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 address permissions for the user
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/addresses" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain a list of all address permissions for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success
code and a collection of address permissions.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "meta": { "page": 1, "count": 1, "pageCount": 1, "totalCount": 1 }, "userId": "c7705a71-dac7-411f-8a7a-d1c6473334cc", "addressPermissions": [ { "addressId": "441259236129", "addressName": "Main line" } ] } |
where:
userId
. The unique ID of the user.addressPermissions
. The user’s address permissions.addressId
. The unique ID of the address that the user has access to.addressName
. The name of the address that the user has access to.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true