Get business units

Get an array of business units.

Method GET
URL /v1/businessUnit/{siteId}

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

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 are:

  • 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 business units.

204

No business units 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/businessUnit/10003715?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
Copy 
{
  "offset": 0,
  "max": 10,
  "sort": "name",
  "order": "ASC",
  "total": 7,
  "records": [
    {
      "id": 19001285,
      "siteId": 10003715,
      "name": "BB-Test",
      "displayName": "",
      "chatAssign": {
        "id": 19001285,
        "waitPeriod": 15
      }
    },
    {
      "id": 13000508,
      "siteId": 10003715,
      "name": "BestBrands",
      "displayName": "",
      "chatAssign": {
        "id": 13000508,
        "waitPeriod": 0
      }
    },
    {
      "id": 19001395,
      "siteId": 10003715,
      "name": "BestBrands-Automation",
      "displayName": "",
      "chatAssign": {
        "id": 19001395,
        "waitPeriod": 0
      }
    },
    {
      "id": 19001059,
      "siteId": 10003715,
      "name": "BestBrands-Demo",
      "displayName": "",
      "chatAssign": {
        "id": 19001059,
        "waitPeriod": 5
      }
    },
    {
      "id": 16000511,
      "siteId": 10003715,
      "name": "BestBrands_Call",
      "displayName": ""
    },
    {
      "id": 14000508,
      "siteId": 10003715,
      "name": "BestBrands_Sup",
      "displayName": ""
    },
    {
      "id": 19001102,
      "siteId": 10003715,
      "name": "Nuance_Agent_Desktop_Test",
      "displayName": "NuanceAgentDesktopTest",
      "chatAssign": {
        "id": 19001102,
        "waitPeriod": 15
      }
    }
  ]
}