Skip to main content

Common Response

All REST endpoints return the same top-level response envelope.

Shape

{
"success": true,
"message": null,
"data": {}
}

Fields

FieldTypeDescription
successbooleanIndicates whether the request succeeded.
messagestringOptional message returned by the server.
dataobjectEndpoint-specific response payload.