Getting Started

The Unleashed API is linked to the Unleashed web application at You will need to create an account there before you can use the API. Demo accounts are also allowed to access the API.

If you are interested in learning more about Unleashed, have a look at our website

Use the API Sandbox to try out accessing and updating your Unleashed account via the API. Your username and password for the API Sandbox will be the same username and password that you chose for the Unleashed application.

A sample application that consumes the API can be downloaded here.

The API URL is To call any API endpoint (method) you must append the endpoint name and parameters to the API URL. eg:

The API accepts both JSON and XML data formats. You must indicate which format you require by setting your request's Content-Type and Accept headers to either "application/xml" or "application/json".

Never assume that the API is actually online at any time. Always queue requests to the API so that you can retry the request in the event of a network failure: even if our API server is up 24/7 forever, the network will not be. Consider what happens in the case of a network interuption, eg the cable gets cut by roadworkers yet again. You should always plan to add all requests to a queue so that they can be tried again in the event of any failure.

Full documentation of each endpoint is available on that endpoint's help page. This includes the operations supported and the full list of available fields with name, type, length and required values. A list of all endpoints is given in the "API Endpoints" section on this page. Use the API Sandbox to see examples of each data object in JSON and XML formats.

The Unleashed API is a subset of the functionality available in the Unleashed application - check the API documentation to see if the functionality you require is available in the API.

In the event of errors, the API will return an appropriate HTML status code, and an error message. You will need to read both the status code and the error message to establish the cause. Typical error messages are documented on the API status codes page.

Beta Release Info

We are intent on continually updating and improving the API in it’s current release. Currently, there are still a number of functions not available through the API and until such time as we have made all functions available the API will remain in beta.

We encourage you to use the API and start developing and integrating your own systems, and as always, we are here to assist as best we can.