REST API Success Response
Standard REST API success envelope with data payload, status, message, and pagination metadata.
API ResponsesRESTAPIpaginationenvelope
Standard REST API success envelope with data payload, status, message, and pagination metadata.
Loading editor...
When to use this template
Use this template when building REST APIs that return a consistent success envelope. The top-level status and message fields let clients quickly determine the outcome, while the pagination object supports cursor- or offset-based list endpoints. Keeping a uniform envelope simplifies error handling on the frontend and makes API documentation more predictable.