Reference
Public Events API
The public events API returns your published events as JSON so a website, app or integration can list them. It is read-only, needs no key, and answers on your registered domain. It is off by default and turned on per organization.
Endpoints (version 1)
| Request | Returns |
|---|---|
| GET /api/public/v1/events | A page of public events, earliest first. Options: limit (1 to 100, default 20), cursor, upcoming=true. |
| GET /api/public/v1/events/next | The next upcoming public event. |
| GET /api/public/v1/events/{slug} | One event plus schema.org structured data to embed in your page. |
Event groups are read the same way, at the same address with event-groups in place of events: the list gives each group's slug, name, parent group and page path, and one group also returns its published events.
Event fields
slug, name, startDateTime, endDateTime, location, description (plain text), imageUrl, capacityStatus (open or sold_out) and path. No attendee or contact details are ever returned. Hidden events and events without a public page are left out.
Paging and errors
Pass nextCursor back as cursor to get the following page; it is null on the last page. Errors use one shape: an error object with a code (not_found, invalid_request, disabled or unavailable) and a message. Within version 1 changes only add fields; the version number is in every response.
Responses are cached for about a minute, and any website may read them.