Skip to main content

Standard Response Format

All API responses follow a consistent structure

Response Structure​

{
"success": boolean,
"message": string,
"errors": array | null,
"data": object | array | null
}

Resources Response Structure​

{
"success": boolean,
"message": string,
"data": object | array
}

Field Descriptions​

FieldTypeDescription
successbooleanIndicates whether the request was successful
messagestringHuman-readable message describing the result
errorsarrayArray of error messages (null if successful)
dataobject/arrayResponse payload (null if error)