Response format .

API responses use regular HTTP status codes and a JSON body, to indicate the result of a request. The JSON body provides a readable format to aid with development.

JSON body.

Each response will have a consistent JSON body to describe the overall result of the request.

{
    "result": "success",
    "status": 200,
    "data": []
}

Body format

Field Description
result Success, fail or error
status Http status code
code A parsable string
message Code description
data Array of data (if applicable)

Result

There are 3 types of results

  • success - 200 status code
  • fail - 400 to 422 status code
  • error - 500 status code

Status

The http status code displayed for reference.

Code

A parsable string that can be used programmatically detect certain results.

Message

A description of the parsable code.

Data

An array of data that relates to the specific request.

Stay in the loop..

Sign up to our newsletter to keep up-to-date.