Introduction

Both request body data and response data are formatted as JSON. Content-type for responses will always be application/json. Generally, all responses will be in the following format:

{
  "status": [string],  // success or fail
  "message": [string], // Explains why status is fail... Entirely informational. Please only log this but do not use for your checks
  "data": [object]    // contains actionable result of processing if present
}

While we generally recommend that developers use HTTP status codes to determine the result of an API call, we have provided a handystatuskey to let you know up front if the request was successful or not.

The message key is a string that will contain a summary of the response and its status. In the event of an error, the message key will contain a description of the error. This is the only key that is universal across requests.

The data key is where you want to look at for the result of your request. It will be an object.