Events API

The Events API allows you to create, update, retrieve, and delete events programmatically.

List Events

Retrieve a paginated list of all events for your organization:

GET /api/v1/events?limit=20&offset=0&status=published

Response:
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Annual Conference 2024",
      "start_date": "2024-06-15T09:00:00Z",
      "end_date": "2024-06-17T18:00:00Z",
      "location": "Convention Center",
      "status": "published",
      "total_guests": 500,
      "checked_in": 0
    }
  ],
  "total": 10,
  "limit": 20,
  "offset": 0
}

Query Parameters

limit (integer) - Number of items to return (default: 20)
offset (integer) - Number of items to skip (default: 0)
status (string) - Filter by status: draft, published, ongoing, completed

Create Event

Create a new event:

POST /api/v1/events

{
  "name": "Annual Conference 2024",
  "description": "Our biggest event of the year",
  "start_date": "2024-06-15T09:00:00Z",
  "end_date": "2024-06-17T18:00:00Z",
  "location": "Convention Center",
  "capacity": 500,
  "event_type": "conference"
}

Get Event Details

GET /api/v1/events/{event_id}

Update Event

PUT /api/v1/events/{event_id}

Delete Event

DELETE /api/v1/events/{event_id}

For complete interactive documentation with try-it-out functionality, visit our Interactive API Explorer.