Get agent groups

Get an array of agent groups.

Method GET
URL /v1/agentGroups/{siteId}/listAg

Request parameters

All parameters are optional.

Parameter

Type

Description

Default value

columns (query)

string

Comma-separated list of columns to return. Supported values are:

  • agentChatDuration

  • customReportsMaxCount

  • description

  • displayName

  • historicDataGoLiveDate

  • id

  • name

  • priority

  • settingId

  • siteId Unique identifier assigned during client-account creation in Nuance Portal.

  • syncAdmin

id, siteId, name, displayName

includeAgentCoach (query)

Boolean

Include agent coach.

false

max (query)

integer

Maximum number of records in response.
Maximum value: 1000.

10

offset (query)

string

Number of skipped records from the start.

0

order (query)

string

Order of records in result list. Supported values:

  • ASC (ascending)

  • DESC (descending)

ASC

sort (query)

string

Field name used for sorting.

name

Response codes

Status

Description

200

Body contains a paginated list of agent groups.

204

No agent group records were found.

For a full list of supported response codes for UMAPI, see Response codes.

Samples

Note: Authentication is required to try out samples. For details, see API token authentication.

url        /portal/configuration/api/v1/agentGroups/10003715/listAg?max=10&sort=name&order=ASC&columns=id%2CsiteId%2Cname%2CdisplayName&filter=%7B%0A%20%20%22columns%22%3A%20%22id%2Cname%2CdisplayName%22%2C%0A%20%20%22textFilter%22%3A%20%22%25%22%0A%7D&agentGroupIds=0
Copy 
{
  "offset": 0,
  "max": 10,
  "sort": "name",
  "order": "ASC",
  "total": 26,
  "records": [
    {
      "id": 10004017,
      "siteId": 10003715,
      "name": ";lakjsd",
      "displayName": ""
    },
    {
      "id": 10008263,
      "siteId": 10003715,
      "name": "Aquila_VA_Sandbox",
      "displayName": ""
    },
    {
      "id": 10004027,
      "siteId": 10003715,
      "name": "BB-Call",
      "displayName": ""
    },
    {
      "id": 10004026,
      "siteId": 10003715,
      "name": "BB-Chat",
      "displayName": ""
    },
    {
      "id": 10005596,
      "siteId": 10003715,
      "name": "BB-Demo",
      "displayName": ""
    },
    {
      "id": 10007892,
      "siteId": 10003715,
      "name": "BB-Mix-Demo",
      "displayName": ""
    },
    {
      "id": 10007112,
      "siteId": 10003715,
      "name": "BB-RT-AUTO",
      "displayName": ""
    },
    {
      "id": 10007198,
      "siteId": 10003715,
      "name": "BB-RT-AUTO2",
      "displayName": ""
    },
    {
      "id": 10004745,
      "siteId": 10003715,
      "name": "BB-SocialMedia",
      "displayName": ""
    },
    {
      "id": 10008127,
      "siteId": 10003715,
      "name": "BB-Store_Hardware",
      "displayName": ""
    }
  ]
}