Migrating to the New API Reference

Update an existing CommPeak integration to the new API names, base URLs, and credentials.

If you built an integration with CommPeak APIs before October 2026, check three things: the API names, the base URLs, and the credentials. Most requests now go through one address, https://api.commpeak.com. The PBX Stats API is deprecated and is not served through api.commpeak.com.

API names

Previous nameCurrent name
CommPeak Billing APIPortal API
Cloud PBX APIPBX API
LookUp APILookup API
TextPeak APITextPeak API and TextPeak Streams API
Dialer APIDialer API (no change)

Base URLs

APIPrevious base URLCurrent base URL
Portal APIhttps://api.commpeak.comhttps://api.commpeak.com/portal
Dialer APIhttps://{subdomain}.td.commpeak.com/apihttps://api.commpeak.com/dialer/{sub_domain}/api
PBX APIhttps://{subdomain}.td.commpeak.com/apihttps://api.commpeak.com/pbx/{sub_domain}/api
Lookup APIhttps://lookup.commpeak.comhttps://api.commpeak.com/lookup

The TextPeak APIs moved to https://api.commpeak.com/textpeak for managing streams and to https://api.commpeak.com/textpeak/streams for sending.

📘

NOTE

The previous base URLs still work for now, but they will be deprecated. Switch your integrations to the current base URLs as soon as you can.

Credentials

The Dialer API and PBX API now use your Portal API key with Full access (all services) instead of an API user and password. To create or update the key, see Creating a Portal API key.

Dispatch Automation and Click2Call have their own authentication and still run on your subdomain, as described in Endpoints you call on your own subdomain. API users, created in Settings > API Management in the Dialer, are now needed only for Dispatch Automation, for integrations that must not see full phone numbers (Mask Phone Number applies only to API users), and for integrations that still call your subdomain directly. The Portal and TextPeak APIs use the same credentials as before. Two more changes affect existing integrations:

  • Lookup API: legacy tokens from the Lookup API Service tab of the CommPeak Portal are deprecated. Switch to a Portal API key with Full access (all services).
  • Portal API (previously the CommPeak Billing API): send the key as the raw Authorization header value. If your integration sends Bearer <API_KEY>, remove the Bearer prefix. The gateway tolerates it, but the raw key is the supported format.

Endpoint pages

Endpoint pages in this API Reference also have new addresses. For example, simplesend is now stream_simple_send, and customerdetails is now customer_details. Update any bookmarks or internal links that point to the previous pages.

No longer available

The following endpoints from the previous API Reference are not served through api.commpeak.com, and requests to them fail. Their previous pages now open the API overview.

  • Dialer API: update a priority group, list and create skill groups, and list, get, and update roles.
  • PBX API: list, create, and update desks, set desk breaks, and list, get, and update roles.

Migrating your integration

Update the base URLs

Replace each base URL in your code or configuration with the current one from Base URLs.

Switch Dialer and PBX to an API key

For Dialer API and PBX API requests, create a Portal API key with Full access (all services) and send it in the Authorization header instead of your API user and password.

Test each API

Make a read-only test request for each API you use, for example the requests in Making your first request.

Check your request rate

The previous limit was 400 requests per minute per company domain and IP address. api.commpeak.com allows about 10 requests per second, so check your peak request rate and retry 429 responses with an increasing delay.

Check your subdomain endpoints

Check that Dispatch Automation and Click2Call requests still go to your own subdomain.

Update links and bookmarks

Update bookmarks and internal links that point to previous endpoint pages.

If a request fails after the change, see Troubleshooting your first request.