Skip to main content

Success envelope

All successful responses use the same top-level structure:

Error envelope

All error responses include success: false and a human-readable message:
Validation-style failures may include an explicit code:

List responses and pagination

Collection endpoints typically return objects with events and pagination:

Field semantics

boolean
required
Indicates whether the request was processed successfully.
string
required
Human-readable outcome message for logging or UX copy.
object
Endpoint-specific payload. Shape varies by endpoint.
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

Error handling

Full status code matrix and retry guidance.

Data models

Canonical object schemas for events, guests, and pagination.