What is the format used for API Calls and Responses

The API is based on HTTP protocol and all data interchanged are in JSON format.

The API calls have the following format:

  • API Endpoint: the url that corresponds to the specific API call
  • apikey: your unique api key
  • Call specific parameters: depending on the API call, you may need to include additional parameters that are specific to the particular call


The response to an API call can be:

  • A JSON object, where its properties are contained in {curly brackets}
  • A JSON array of objects, where the collection of the objects is contained in [square brackets]


Powered by Zendesk