List Events
Returns events with their post title, calendar and guest count, filtered and paginated, for the admin events list and calendar grid.
Each event carries guests_count: every guest row of the event, whatever its status. Results are sorted by period. With both start_date and end_date set to a window of at most 62 days and paginate=false, the endpoint returns every event in the window as a plain list, which is what the calendar grid uses. Any other request is paginated. Pagination follows the WPFluent paginator: the response has data, total, per_page, current_page, last_page and the page URLs.
Endpoint
- Method:
GET - Path:
/fluent-event/v2/events - Controller:
EventController@getAllEvents - Route source:
fluent-event/app/Http/Routes/api.php:52 - Controller source:
fluent-event/app/Http/Controllers/EventController.php:18
Permissions
- Requires the
manage_optionscapability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.
Hooks Fired
Live sample
The request and response below were recorded on a running FluentEvent site and then anonymised. Names, emails and event titles are fictional, and long lists are cut to a few items.
List Events
Returns events with their post title, calendar and guest count, filtered and paginated, for the admin events list and calendar grid.
Controller: EventController@getAllEvents
Route source: fluent-event/app/Http/Routes/api.php:52
Authorizations
A WordPress username and an Application Password.
Parameters
Query Parameters
Start of a date range, Y-m-d, in the site's time zone. Matches events that end on or after this day.
End of a date range, Y-m-d, in the site's time zone. Matches events that start on or before this day.
Matches the event title.
"meetup"Only events in this calendar.
Only events with this status.
"public""unlisted""private""draft"upcoming: not ended yet, soonest first. past: ended, latest first. Anything else: upcoming first, then by distance from now.
"upcoming""past""all""upcoming"Set to false with a date window of at most 62 days to get every event in the window without paging.
trueItems per page.
5110020Page number, starting at 1.
Responses
Success