Skip to content

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_options capability (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​

GET
/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​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Query Parameters

start_date

Start of a date range, Y-m-d, in the site's time zone. Matches events that end on or after this day.

Type
string
end_date

End of a date range, Y-m-d, in the site's time zone. Matches events that start on or before this day.

Type
string
search

Matches the event title.

Type
string
Example"meetup"
calendar_id

Only events in this calendar.

Type
integer
status

Only events with this status.

Type
string
Valid values
"public""unlisted""private""draft"
period

upcoming: not ended yet, soonest first. past: ended, latest first. Anything else: upcoming first, then by distance from now.

Type
string
Valid values
"upcoming""past""all"
Example"upcoming"
paginate

Set to false with a date window of at most 62 days to get every event in the window without paging.

Type
boolean
Default
true
per_page

Items per page.

Type
integer
Example5
Minimum
1
Maximum
100
Default
20
page

Page number, starting at 1.

Type
integer

Responses​

Success

application/json
JSON
{
  
"events": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"id": 0,
  
  
  
  
"post_id": 0,
  
  
  
  
"calendar_id": 0,
  
  
  
  
"parent_event_id": "string",
  
  
  
  
"status": "string",
  
  
  
  
"start_at": "string",
  
  
  
  
"end_at": "string",
  
  
  
  
"timezone": "string",
  
  
  
  
"venue_type": "string",
  
  
  
  
"meta": {
  
  
  
  
  
"cover_url": "string",
  
  
  
  
  
"online_meeting_url": "string",
  
  
  
  
  
"venue": "string",
  
  
  
  
  
"address": "string",
  
  
  
  
  
"entry_type": "string",
  
  
  
  
  
"show_guest_count": "string",
  
  
  
  
  
"capacity": 0,
  
  
  
  
  
"show_spots_left": "string",
  
  
  
  
  
"start_display": "string",
  
  
  
  
  
"description_md": "string"
  
  
  
  
},
  
  
  
  
"created_at": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"guests_count": "string",
  
  
  
  
"title": "string",
  
  
  
  
"start_at_local": "string",
  
  
  
  
"end_at_local": "string",
  
  
  
  
"start_at_site": "string",
  
  
  
  
"end_at_site": "string",
  
  
  
  
"calendar": {
  
  
  
  
  
"id": 0,
  
  
  
  
  
"title": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"theme_color": "string"
  
  
  
  
  
}
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": 0,
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"url": "string",
  
  
  
  
"label": "string",
  
  
  
  
"active": true
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": 0,
  
  
"total": 0
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation