Skip to main content

Response format

Every response shares the same structure:

Common structure
{
"response_code": 200,
"response_status": "Success",
"response_message": "Operación exitosa",
"data": {}
}
FieldTypeDescription
response_codeintegerHTTP status code of the response.
response_statusstringSuccess / success when the operation succeeded, Error / error when it failed.
response_messagestringHuman-readable result message (in Spanish).
dataobject | arrayResponse payload.
warning

response_status may come capitalized (Success, Error) or in lowercase (success, error), depending on the endpoint. Compare it case-insensitively, or use response_code to know whether the operation succeeded.

:::info Extra fields Some responses include extra fields at the root level. For example, the login returns the token in token instead of data. :::