REST

Important Note

  • To login you need to use a valid account who has permission to use the API.
  • All Data is Encrypted (HTTPS)
  • Enabled for Specific Projects & Users only
  • Only access the information you can through the Web UI.

Overview

A REST API is available for bi-directional integration with many different applications and technologies.

There is a web interface which can be used to see and test all available interfaces here:

https://au.itwocx.com/api/latest/api/help


Examples


Versions

You can see the latest version information and changes here: API Release Notes

To avoid breaking changes, we release new API versions a few times per year, it is recommended to ensure your API queries utilise the redirection from api/latest to api/{version} for the particular deployment (url) of iTWO cx you are connecting to.

e.g. https://au.itwocx.com/api/latest redirects to https://au.itwocx.com/api/22.12

In C# this could be managed as follows.

Uri currentApi;
using (var httpClient = new HttpClient())
{
	var response = httpClient.GetAsync("https://au.itwocx.com/api/latest/").Result;
    currentApi = response?.RequestMessage?.RequestUri;
}

using (var apiClient = new CXApiClient(currentApi)) {
    // Code Here
}