API Access Notes

API Usage Notes

API Calls vs. Admin Labels

You might have noticed that the API calls in the different documentation pages do not match the fields that you can see when you navigate the administration interface. Call GET /{version}/clients/{clientId}/clientFields/locales/{locale} to get some idea about the relations between the two.


On success, every call will return a HTTP 200 return code (or 304, if appropriate) along with a call-specific data structure.

On error, every call will return an appropriate HTTP status code and the following JSON structure.

Example Error Object

    error     : "ERROR_NAME",
    message   : "Some message",