Get all groups

The GET /groups endpoint gets a list of all groups that the requestor has access to.

Headers

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

Authorization scopes supported:

Parameters

The endpoint accepts the following query parameters:

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 all groups

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

Request second page of groups

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

Responses

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

Successful response

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

Example response

{
  "meta": {
      "page": 1,
      "count": 7,
      "pageCount": 1,
      "totalCount": 7
  },
  "groups": [
    {
      "groupId": "38baddf8-932d-4bb4-9840-5e28f719fa3e",
      "groupName": "Group1",
      "groupMaxUnexpectedTime": 500,
      "groupMaxWrapUpTime": 500,
      "groupDisplayId": "44587"
    },
    {
      "groupId": "faa79c3e-2056-4757-ad12-676c7e5cdf5c",
      "groupName": "Group2",
      "groupMaxUnexpectedTime": 500,
      "groupMaxWrapUpTime": 500,
      "groupDisplayId": "699854"
    },
    {
      "groupId": "1613a31b-91e2-4a42-90a4-b4523d0388a5",
      "groupName": "Group3",
      "groupMaxUnexpectedTime": 500,
      "groupMaxWrapUpTime": 500,
      "groupDisplayId": "2547"
    }
  ]
}

where:

• groups. A collection of groups.
  
  • groupId. The unique ID of the group.
    
  • groupName. The group’s name, used for display purposes throughout the Vonage Contact Center (VCC) platform.
  • groupMaxUnexpectedTime. The maximum time, in seconds, that a user in the group can be in any of the Unexpected or Fault states, such as Fault on Line, No Answer, or Line Busy. The default is 10 seconds.
  • groupMaxWrapUpTime. The maximum time, in seconds, that a user in the group can be in the Wrap Up (Auto) state. The default is 10 seconds.
  • groupDisplayId. The group's unique ID.