🔌 API Reference

Guests API

Manage event guests and attendees

Guests API

Manage event guests, including adding, updating, importing, and exporting guest lists.

List Guests

Retrieve all guests for a specific event:

GET /api/v1/events/{event_id}/guests?limit=50&offset=0

Query Parameters:
- limit (integer): Number of items to return
- offset (integer): Number of items to skip
- status (string): Filter by RSVP status (accepted, declined, pending)
- checked_in (boolean): Filter by check-in status

Add Guest

Add a new guest to an event:

POST /api/v1/events/{event_id}/guests

{
  "first_name": "Jane",
  "last_name": "Smith",
  "email": "jane@example.com",
  "phone": "+1234567890",
  "guest_type": "vip",
  "send_invitation": true
}

Bulk Import Guests

Import guests from a CSV file:

POST /api/v1/events/{event_id}/guests/import

Rate limit: 10 requests/hour

Export Guest List

Download guest list as CSV:

GET /api/v1/events/{event_id}/guests/export

Guest Fields

  • first_name (required) - Guest's first name
  • last_name (required) - Guest's last name
  • email (required) - Email address
  • phone (optional) - Phone number with country code
  • guest_type (optional) - vip, regular, speaker, staff
  • send_invitation (optional) - Send invitation email (default: false)

© 2025 FreePas. All rights reserved.