Each response will return same json object with following structure. API will return OK (Status=200) only when Success=true, otherwise 400 error will be returned (bad data or similar with error messages)

Field name Data type Description
Success bool Indicates if request is successful
Errors array Error messages. This array will be empty if Success=true
Data object Contains result, type can wary depending on request type

Sample success response

status=200 OK

Copy to Clipboard

Sample error response

status=400 Bad Request

Copy to Clipboard