Get user's interaction plan permissions

The GET /users/{userId}/permissions/interactionPlans endpoint gets a list of all interaction plan permissions for the user matching the user ID provided.

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

Parameters

The endpoint accepts the following query parameters:

userID

The user ID of the required user.

limit

The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.

page

The required page. Minimum of 1, maximum of 1000000000. Default is 1.

Requests

Request a list of interaction plan permissions for the user

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/interactionPlans" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Responses

Responses contain a list of all interaction plan permissions for the user matching the user ID provided.

Successful response

Successful requests return a 200 Success code and a collection of interaction plan permissions.

Example response

{
  "meta": {
    "page": 1,
    "count": 1,
    "pageCount": 1,
    "totalCount": 1
  },
  "userId": "6a7999e1-a0a0-4341-bf4f-eb508fa1b2ff",
  "interactionPlanPermission": [
    {
      "interactionPlanId": "2a0acac6-1f5f-4c45-a0f1-c77c639782a2",
      "interactionPlanName": "test interaction plan"
    }
  ]
}

where:

• userId. The unique ID of the user.
  
• interactionPlanPermission. The user’s interaction plan permissions.
  
  • interactionPlanId. The unique ID of the interaction plan that the user has access to.
  • interactionPlanName. The name of the interaction plan that the user has access to.