Standard Returns

The Brick API has an standard body response

FieldData TypeDescription
dataGenericThe response content
statusIntegerThe HTTP status
errorsArray of ErrorsThe errors that occurred during the execution

Brick uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with Brick’s servers (these are rare).

Errors will always be followed by an Array of codes and messages to help your debug. You can see more details about Error Handling on the Error Messages section.