Business Endpoints

A Business represents the Enterprise or top-level entity responsible for managing their associated Business Units. The following endpoints are available at the Business level:

Get Business Details

A GET action returning all available data for the specified business. This includes the Legal Name of the business, DBA, Primary Phone Number, aNumbers , Addresses, Admin Contacts, Website, Duns Number (if available), Business Units, Programs, and Delivery Channels. For a full example of the response object, please see the above-linked API reference page.

Business Metrics

Metrics associated with the entire Business may be called, returning aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Business Metrics API reference.

📘

outputType

Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.

See sample Business metrics response object below:

{
    "body": {
        "businessMetricsSummaries": [
            {
                "businessId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
                "metrics": [
                    {
                        "answerRate": 0.34526357,
                        "declineRate": 0.12345,
                        "totalTreatedCalls": 123453
                    }
                ]
            },
            {
                "businessId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
                "metrics": [
                    {
                        "answerRate": 0.34526357,
                        "declineRate": 0.12345,
                        "totalTreatedCalls": 123453
                    }
                ]
            }
        ]
    },
    "error": null
}

Business Contacts

A collection of endpoints offering the management of contacts associated with a specific Business.

List Contacts

A GET action returning all existing administrative contacts available for a specified Business.

Create Contact

A POST action providing the ability to add a new administrative contact to a specified Business.

Get Contact Details

A GET action returning all available data (i.e. Name, Email, Phone Number) for a specific contact within a Business.

Update Contact

A PUT action providing the ability to alter the information associated with a specific administrative contact.

Delete Contact

A DELETE action that removes an individual contact from the specified Business.

Business Addresses

A collection of endpoints offering the management of addresses associated with a specified Business. All Businesses can assign a primary address, and secondary addresses as needed.

List Addresses

A GET action returning all existing addresses associated with a specified Business.

Create Addresses

A POST action providing the ability to add a new address to a specified Business.

Get Address Details

A GET action returning available address data (i.e. City, State, Postal Code, Country, Street Number) for a specified Business.

Update Address

A PUT action providing the ability to alter existing information for a specified address.

Delete Address

A DELETE action removing an existing address from a Business.

Business Reference Data

A collection of endpoints offering data points for reference associated with Businesses.

List Business Industries

A GET action that returns the industries a Business is defined as.

See sample Business industries reference data response object below

{
  "body":{
    "callPurposes":[
      { 
        "industryId":"12",
        "industry":"Automotive",
        "displayOrder":1
      },
      { 
        "industryId":"DC",
        "industry":"Business Services",
        "displayOrder":2
      },
    ]
  }
}

Business Industries:

List Employee Count Ranges

A GET action that returns the employee size of a business as a count range.

See sample Business employee count ranges reference data response object below:

{
  "body":{
    "employeeCountRanges":[
      { 
        "rangeId":9,
        "range":"Unknown",
        "displayOrder":1
      }
      { 
        "rangeId":1,
        "range":"1-10 employees",
        "displayOrder":2
      },
      { 
        "rangeId":2,
        "range":"11-51 employees",
        "displayOrder":3
      }
    ]
  }
}

Employee Count ranges: