All of our articles assume that you have read the API Documentation, created an API Credential and made a successful test call. Please note, you must be signed in to Sandbox to access the API documentation.
When we discuss calling an endpoint we specify the method (e.g. GET) and the full URL as if used against the CreateiQ Sandbox environment. To use against the Live environment you would replace the hostname with 'api.createiq.tech'.
To see full parameter and response details for a given endpoint, consult the API Documentation.
We assume that you will be adding an Authorization header to properly authenticate each call.
Placeholders are shown beginning with colons, such as
:negotiationId, to indicate that you should replace this field with the appropriate identifier.Browsers and Allowlisting
CreateiQ is designed to be used on modern browsers, such as Microsoft Edge, Google Chrome or Mozilla Firefox.
To receive our emails, please ensure that your organisation does not block or filter: support@createiq.tech.
For more information on browsers and allowlisting, please see: https://sandbox.app.createiq.tech/technical-requirements
Working from the Windows Command Prompt
If you're following along with these examples using
curl from the Windows command prompt, based on our curl examples in the API Documentation that's available on the platform, you may need to make a few small adjustments.Backslashes
Examples are often spaced for readability using backslashes, e.g.:
curl \ https://app.createiq.tech
Windows does not support this standard, and the curl command will need to be moved into one line by removing all the backslashes before it will run in the Windows terminal, like so:
curl https://app.createiq.tech