--- url: /api/events.md description: >- Learn how to create, read, update, and delete events via Add to Calendar PRO's API for seamless event management and RSVP user flows. --- # Events API ::: info Style = Layout Styles are referenced with the key "layout". ::: ## Get all events ``` GET /event/all ``` Gets a list with the ids, prokeys, and labels (generated string for identification) of all available events. ``` GET /event/all?from=:timestamp&to=:timestamp&group=:group-prokey&dates=:boolean ``` Optionally filter the entries by time and group. Use "from", "to", "group" - or all three parameters. Allowed values for datetimes: * `now` (to use the current server time). * a valid UTC ISO datetime without milliseconds (like `2025-11-03T20:06:27Z`) Optionally also get the dates object per item by adding `dates=true` to the query. ::: info For recurring or multi-date events, the earliest start and latest end across all dates are used for filtering. ::: ## Get the latest event ``` GET /event/latest ``` Gets the latest event. Id, prokey, label, and optional dates object (if query param is given; see above). ## Get one event ``` GET /event/:prokey ``` Reading a sepcific event does not allow for any additional parameters. It only takes the prokey in the request url and simply provides you with all data for this one. ### Potential response ```json { "status": "published", "dates": [ { "name": "Date 1", "startDate": "2024-11-14", "endDate": null, "timeZone": "Europe/Berlin", "organizer_name": "", "organizer_email": "", "description": "

A short description.

", "location": "Nowhere" }, { "name": "Date 2", "startDate": "2024-11-15", "endDate": null, "timeZone": "Europe/Berlin", "organizer_name": "", "organizer_email": "" } ], "title_event_series": "Dummy Event Series", "simplified_recurrence": true, "recurrence": null, "recurrence_interval": null, "recurrence_count": null, "recurrence_byDay": null, "recurrence_byMonthDay": null, "recurrence_byMonth": null, "recurrence_weekstart": null, "recurrence_simple_type": null, "layout": null, "landingpage": null, "iCalFileName": null, "rsvp": false, "rsvp_block": null, "cta": true, "cta_block": 74, "hideButton": false, "distribution": true, "sequence": "10", "date_created": "2024-11-01T12:57:25.983Z", "date_updated": "2024-11-02T18:20:56.152Z", "event_group": "803a96ac-aaaa-2222-bbbb-6fb191041543", "prokey": "99ec3e7f-ef04-bbbb-a3d7-e30736faaaaa" } ``` ## Add an event ``` POST /event ``` Creating a new event requires you to at least provide the following fields in the body: ```json { "event_group": "prokey-of-event-group", // gets returned, when creating a group; also visible in the application "dates": [{ "name": "Title of the date", "startDate": "2024-12-24", "timeZone": "America/Los_Angeles" // not required, but highly recommended }] } ``` Instead of `event_group`, you can also use `new_event_group_name`, which takes a string. This will create a new group with the provided name instead of linking the event to an existing one. Going further, you can add more dates to the array (= multi-date event). ::: warning Limitations Mind limitations, like recurrence not allowing for multiple dates, etc. We recommend to create a potential setup in the application first, before building it via the API. Additionally, the API does not allow to set the status of an event - it will always be published on creation. ::: ### Potential request with all fields ```json { "event_group": "prokey-of-event-group", "dates": [{ "name": "Title of the date", "description": "

An event description

", // allowing for

, , , ,

,

,

,

,