View Source

The GET /users endpoint gets a list of all users that the requester has access to.

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:

`include`

Type	Required	Example
String	True	`Active`

The types of users to include in response. Possible values are Active, Archived, and All. Defaults to Active.

`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 active users

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Request all users

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users?include=All" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Request page 2 of users

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users?page=2" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Responses

Responses contain a list of all users that the requester has access to.

Successful response

Successful requests return a 200 Success code and a collection of users.

Example response

{
  "users": [
    {
      "userId": "8e22b1fe-d2ea-403d-8c03-50eb21188e79",
      "username": "supervisor",
      "name": "Supervisor",
      "email": "supervisor@vonage.com",      ,
      "lastLoginTime": "2021-08-26T07:37:55.465Z",
      "active": true,
      "locked": false,
      "ssoExternalId": "exampleSso",
      "userAccountConfiguration": {
        "role": "Supervisor",
        "chargeable": true,
        "actAsAgent": true,
        "agentConfiguration": {
          "agentDisplayId": "123",
          "webrtc": true,
          "agentControlWebrtc": true,
	      "handleMultipleInteractions": true,
          "enforcedDispositionCodes": false,
          "transcribeCalls": true,
          "screenRecording": false,
          "callParking": true,
          "salesCadence": false,
          "outboundAutoanswer": true,
          "inboundAutoanswer": true,
          "outboundWrapUp": 100,
          "backToReadyAfterNoAnswer": 100,
          "backToReadyAfterLineBusy": 90,
          "backToReadyAfterInvalidNumber": 80,
          "backToReadyAfterNetworkIssue": 5,
          "callRatingFrequency": 56,
	      "video": true,
    	  "transcribeCallsRealTime": true,
      	  "callRecordingControls": true,
          "location": "GB",
          "telephonyAddress": {
            "telephoneAddress": "800100",
            "telephonyExtension": "44",
            "outboundTelephonyRegion": "8a8256e6-9e5f-4c94-8afe-5a4a7dfaeadd",
            "nationalDisplay": true,
            "virtualLocation": "PL",
			"preventAutoCallbackNumber" : true,
			"selectedCallbackNumberId": "4c0b6793-a4c9-4075-839e-08fb99ba7efd"
          },
          "capacity": {
            "isAgentLevel": false,
            "live": 60,
            "nonlive": 15,
            "semilive": 75
          },
          "associatedUsers": [
            {
              "username": "supervisor_vbc",
              "applicationType": "VBC"
            }
          ]
        }
      }
    },
    {
      "userId": "bb776f59-1802-2faa-d0cf-10b696b361b7",
      "username": "wallboard",
      "name": "Wallboard",
      "email": "wallboard@vonage.com",
      "userId": "79278e18-285e-4064-9db8-d38bc411a007",
      "lastLoginTime": "2021-08-26T07:37:55.465Z",
      "active": true,
      "locked": false,
      "ssoExternalId": "exampleSso",
      "userAccountConfiguration": {
        "role": "Wallboard",
        "chargeable": true,
        "actAsAgent": true,
        "agentConfiguration": {
          "agentDisplayId": "123",
          "webrtc": true,
          "agentControlWebrtc": true,
      	  "handleMultipleInteractions": true,
          "enforcedDispositionCodes": false,
          "transcribeCalls": true,
          "screenRecording": false,
          "callParking": true,
          "salesCadence": false,
          "outboundAutoanswer": true,
          "inboundAutoanswer": true,
          "outboundWrapUp": 100,
          "backToReadyAfterNoAnswer": 100,
          "backToReadyAfterLineBusy": 90,
          "backToReadyAfterInvalidNumber": 80,
          "backToReadyAfterNetworkIssue": 5,
          "callRatingFrequency": 56,
      	  "video": true,
    	  "transcribeCallsRealTime": true,
	      "callRecordingControls": true,
          "location": "GB",
          "telephonyAddress": {
            "telephoneAddress": "800100",
            "telephonyExtension": "44",
            "outboundTelephonyRegion": "983893d9-cf27-42a6-a4b7-52c0b8b5d189",
            "nationalDisplay": true,
            "virtualLocation": "PL",
			"preventAutoCallbackNumber" : true,
			"selectedCallbackNumberId": "6d2bb5df-b304-49e6-a95f-aa9482d74386"
           },
          "capacity": {
            "isAgentLevel": false,
            "live": 60,
            "nonlive": 15,
            "semilive": 75
          },
          "associatedUsers": [
            {
              "username": "wallboard_vbc",
              "applicationType": "VBC"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "count": 2,
    "pageCount": 1,
    "totalCount": 2
  }
}

users is a collection of users where: