Api Documentation



To provide a secure API, use of the HTTPS protocol is mandatory.

URL Prefix

In order to maintain version integrity into the future, the API is versioned. All calls currently begin with the following prefix:


RESTful Interface

Wherever possible, the API seeks to implement repeatable patterns with logical, representative URLs and descriptive HTTP verbs. Below are some examples and conventions you will see throughout the documentation.

  • LIST will retrieve informaton about a collection
  • GET will retrieve informaton about an element
  • CREATE will create an element in a collection
  • UPDATE will update a single element in a collection
  • DELETE will destroy a single element

Sending Data

Information can be sent in the body of a request as JSON (JavaScript Object Notation) or Xml (Extensible Markup Language). Please use the toggle switch in the top right corner of the console to toggle between JSON and Xml examples across the various endpoints. To switch between JSON and Xml as input and output in the API, please set the Content-Type header to application/json or application/xml respectively.


Example data structure

    "key": "value",
    "key_multiple_values": [