Skip to main content

Success envelope

All successful responses use the same top-level structure:
{
  "success": true,
  "message": "Descriptive success message",
  "data": {}
}

Error envelope

All error responses include success: false and a human-readable message:
{
  "success": false,
  "message": "Error description"
}
Validation-style failures may include an explicit code:
{
  "success": false,
  "message": "Validation failed",
  "code": "validation_error"
}

List responses and pagination

Collection endpoints typically return objects with events and pagination:
{
  "success": true,
  "message": "Events fetched successfully",
  "data": {
    "events": [],
    "pagination": {
      "limit": 20,
      "offset": 0,
      "total": 42
    }
  }
}

Field semantics

success
boolean
required
Indicates whether the request was processed successfully.
message
string
required
Human-readable outcome message for logging or UX copy.
data
object
Endpoint-specific payload. Shape varies by endpoint.
code
string
Optional machine-readable error category.

Surface differences

Public API

Rich payloads with creator metadata, links, contributions, and pagination.

Embed API

Lean payloads optimized for browser rendering with computed event status.

Next steps