Try CXone APIs

You can test CXone APIs directly from this site with the Try It Out feature. The documentation for each API has a Sign In to Try It Out button. Click the button to edit the fields and enter your own values. Execute the API, and the Responses section updates with your response. This helps you explore the capabilities of the CXone APIs and plan your own app's programming.

Displays the image of Get agents API from Developer portal.

This feature allows you to test APIs with your organization's CXone environment. To test the APIs, you must authenticate with a CXone user account. The first time you click a Sign In to Try It Out button, you are redirected to an authentication page. Enter your CXone username and password, then you can continue and test the API. The site caches your credentials, so you can continue testing other APIs until your cache is cleared. Any calls that you make are to your environment with which you authenticated.

Displays the image of try it out flow from Developer portal.

Find URL Segment

The Try It Out feature helps you quickly find the full API URL for a request. The full URL has two parts, the base URL and the endpoint. The base URL can be used for every API call. You can determine your base URL as part of the API discovery process, explained on the Getting Started Page. When you sign in to try out the APIs, this site manages the base URL for you, so you can test the APIs without needing to build a full URL. The endpoint includes the path to access the resource, including the API version. After trying out the API, you can see the full URL used, which may be useful to see the full endpoint path or the base URL.

To find the full URL when testing an API:

  1. Navigate to the documentation for the endpoint you want to use.
  2. Expand the documentation and click Sign In Try it out. If you've already logged in with your CXone credentials, the button text is Try it out.
  3. Follow the log in process and enter your CXone account credentials. This lets you make API calls with your CXone tenant.
  4. Enter any required parameters into the field descriptions.
  5. Click Execute. The response returns as a Curl request. It also includes a Request URL. Either contain the full request URL, showing any additional segments of the base URL.