Request and Responses

JSON is used to format both the request body and the returned data (response). Application/JSON will always be the content type for responses. In general, all responses will be formatted as follows:

FieldDatatypeDescription

status

String

Helps differentiate responses, it either returns 'success' or 'failed'

message

String

Gives a description of the status returned (do not use for your checks)

data

Object

Contains actionable result of a successfully processed request if present

errors

Array

Contains errors pertaining to a request body (e.g invalid parameter submitted)

Last updated