Skip to main content

Overview

The Event Management API provides endpoints for organizations to manage their events, including agendas, volunteer jobs, assignments, and RSVP tracking. All endpoints require authentication and event management permissions for the organization.

Base URL

All event management endpoints are prefixed with:
/org-event-management/{orgId}/events

Authentication

All endpoints require:
  • Bearer Token: Passed in the Authorization header
  • Event Management Permissions: User must have event management permissions for the specified organization

Key Features

Agenda Management

  • Create and update event agendas
  • Publish agendas to mark them as complete
  • Automatic isPublished reset on modifications

Job & Assignment Management

  • Create event jobs from templates
  • Assign volunteers to job positions
  • Remove assignments when needed
  • Track job coverage and staffing status

RSVP Growth Tracking

  • Track daily RSVP counts
  • Dynamic projection calculations
  • Support for past and future events
  • Guest count tracking

Common Response Format

All endpoints follow a consistent response structure:
success
boolean
Indicates whether the request was successful
message
string
Human-readable message describing the result (optional)
data
object
Response data (varies by endpoint)
error
string
Error message details (only present on error responses)

Endpoints

Agenda Endpoints

Assignment Endpoints

Analytics Endpoints

Error Handling

All endpoints return appropriate HTTP status codes:
  • 200 - Success
  • 201 - Created
  • 400 - Bad Request (validation errors)
  • 401 - Unauthorized (missing/invalid token)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found (resource doesn’t exist)
  • 500 - Internal Server Error

Rate Limiting

API rate limits apply to prevent abuse. Check response headers for rate limit information:
  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

Best Practices

  1. Always check success field before processing response data
  2. Handle errors gracefully - display user-friendly error messages
  3. Cache data appropriately - RSVP growth data can be cached for a few minutes
  4. Use pagination - For endpoints that return lists, use pagination parameters
  5. Validate input - Client-side validation improves UX and reduces errors