API Response

All API responses from our server will be in the following formats below.

Successful responses

On a successful request, we will always return an object with success: true, and a data object or array with the relevant data inside.

Please see the relevant API endpoints for more details of the specific data payload that you'll receive.

Single success response

{
  "success": true, 
  "data": {
    "key1": "value1",
    "key2": "value2",
  }
}

Multiple success response

{
  "success": true, 
  "data": [
    {
      "key1": "value1",
      "key2": "value2",
    },
    {
      "key1": "value1",
      "key2": "value2",
    }  
  ]
}

Failed responses

We will always return success: false, and an error object with the details of the error.

The error type will be either a client_error, validation_error or a server_error. Please see API Error Types for more information.

The details will be an object if a single error occurred during the request, or an array of objects if there were multiple errors.

Single error response

{
  "success": false,  
  "error": {
    "type": "client_error" | "validation_error" | "server_error",  
    "detail": {
      "code": "...", 
      "message": "..."
    }
  }
}

Multiple error response

{
  "success": false,  
  "error": {
    "type": "client_error" | "validation_error" | "server_error",  
    "detail": [
      {
        "code": "...", 
        "message": "..."
      },
      {
        "code": "...", 
        "message": "..."
      }
    ]
  }
}