Skip to main content

Responses and Errors

Success Envelope​

{
  "success": true,
  "data": [],
  "meta": {
    "page": 1,
    "limit": 100,
    "total": 2540
  }
}

Error Envelope​

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

Error Codes​

  • UNAUTHORIZED -> 401
  • FORBIDDEN -> 403
  • METHOD_NOT_ALLOWED -> 405
  • RATE_LIMITED -> 429
  • HTTPS_REQUIRED -> 403
  • INTERNAL_ERROR -> 500