Skip to main content
Every response uses a consistent JSON envelope with a top-level success flag.

​
Success

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

​
Error

{
  "success": false,
  "code": "validation_error",
  "message": "The request contains invalid data.",
  "errors": {
    "email": ["Enter a valid email address."]
  }
}
FieldTypeDescription
successbooleanAlways false on errors
codestringMachine-readable error code
messagestringHuman-readable description
errorsobjectOptional field-level validation errors

​
Paginated list response

List endpoints wrap results in a data array and add a pagination object. 
{
  "success": true,
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 320,
    "pages": 7
  }
}