API Responses

This page describes the structure of API responses and common HTTP status codes.

Response Format

All API responses are returned in JSON format.

Successful Response

{
  "data": {
    "id": "abc123",
    "type": "resource",
    "attributes": {
      "name": "Example"
    }
  }
}

Error Response

{
  "error": {
    "code": "validation_error",
    "message": "The request was invalid",
    "details": [
      {
        "field": "email",
        "message": "Invalid email format"
      }
    ]
  }
}

HTTP Status Codes

Code	Description
200	OK - Request succeeded
201	Created - Resource created successfully
400	Bad Request - Invalid request parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
404	Not Found - Resource doesn't exist
422	Unprocessable Entity - Validation error
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error - Server error

Pagination

List endpoints return paginated results:

{
  "data": [...],
  "pagination": {
    "total": 100,
    "page": 1,
    "per_page": 20,
    "total_pages": 5
  }
}