Skip to Content
Public

Get a public event

Event details, form fields, theme and counts for the widget. No guest personal data. Private, draft and unknown events all answer 404 `event_not_found`. No key needed. CORS is open to any origin. Cached at the CDN for 15 seconds (`s-maxage=15, stale-while-revalidate=60`).

GET
/v1/public/events/{id}

Event details, form fields, theme and counts for the widget. No guest personal data. Private, draft and unknown events all answer 404 event_not_found. No key needed. CORS is open to any origin. Cached at the CDN for 15 seconds (s-maxage=15, stale-while-revalidate=60).

Path Parameters

id*string
Match^evt_[0-9A-Za-z]{6,64}$

Response Body

The event.

application/json
  1. response

What a guest may see about an event. Counts only, never guest names.

id*string
mode*string

live or test. Always the mode of the API key that made the request.

Value in"live""test"
title*string
description*string|null
starts_at*string

ISO 8601 with a UTC offset.

Formatdate-time
ends_at*|

ISO 8601 with a UTC offset.

Formatdate-time
timezone*string
location_name*string|null
location_address*string|null
online_url*string|null
price_note*string|null
cover_image_url*string|null
status*string
Value in"draft""published""cancelled"
visibility*string

Private events are never served here (404 event_not_found).

Value in"public""unlisted"
state*string

What the widget should show: open, full_waitlist (full, new RSVPs join the waitlist), full, ended or cancelled. New values may be added; treat an unknown one like open without the RSVP button.

Value in"open""full_waitlist""full""ended""cancelled"
capacity*integer|null
max_guests*integer
waitlist_enabled*boolean
counts*
fields*array<>
url*string
calendar*
organizer*
branding*
turnstile_site_key*|

Null when no bot check is configured; the RSVP then needs no token.

Example Request
curl -X GET 'https://api.whocoming.com/v1/public/events/string'
Example Response
{  "id": "string",  "mode": "live",  "title": "string",  "description": "string",  "starts_at": "2019-08-24T14:15:22Z",  "ends_at": "2019-08-24T14:15:22Z",  "timezone": "string",  "location_name": "string",  "location_address": "string",  "online_url": "string",  "price_note": "string",  "cover_image_url": "string",  "status": "draft",  "visibility": "public",  "state": "open",  "capacity": 0,  "max_guests": 0,  "waitlist_enabled": true,  "counts": {    "going": 0,    "waitlisted": 0,    "spots_left": 0  },  "fields": [    {      "key": "string",      "label": "string",      "type": "text",      "required": true,      "options": [        "string"      ]    }  ],  "url": "string",  "calendar": {    "ics_url": "string",    "google_url": "string"  },  "organizer": {    "id": "string",    "name": "string",    "slug": "string",    "logo_url": "string",    "accent_color": "string"  },  "branding": {    "show_badge": true  },  "turnstile_site_key": "string"}