Skip to content

List Community Events ​

Returns the events the caller can see in the FluentCommunity portal, with their space and the caller's own status.

An event appears when its community post is published, its author's profile is active, and the caller can see the post's space (or, for an event outside any space, can see the portal feed). Draft events never appear.

With a from/to window of at most 62 days and paginate=false, every event in the window comes back in one page.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/community/events
  • Controller: CommunityEventController@getEvents
  • Route source: fluent-event/app/Http/Routes/api.php:69
  • Controller source: fluent-event/app/Http/Controllers/CommunityEventController.php:26

Permissions ​

  • Open to anyone FluentCommunity lets into its portal, logged in or not, while the FluentEvent feature is on in FluentCommunity. A member whose community profile is not active is refused. Each event is then shown only if its community post is visible to the caller.

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 Community Events​

GET
/community/events

Returns the events the caller can see in the FluentCommunity portal, with their space and the caller's own status.

Controller: CommunityEventController@getEvents
Route source: fluent-event/app/Http/Routes/api.php:69

Authorizations​

cookieAuth

Logged-in cookie plus a wp_rest nonce. The browser sends the cookie.

Type
API Key (header: X-WP-Nonce)

Parameters​

Query Parameters

space

Only events in this space (slug).

Type
string
from

Y-m-d. Events that end on or after this day.

Type
string
to

Y-m-d. Events that start on or before this day.

Type
string
search

Matches the event title.

Type
string
scope

Which events, and in which order.

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

Set to false with a window of at most 62 days.

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": [
  
  
{
  
  
  
"id": 0,
  
  
  
"title": "string",
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"start_at": "string",
  
  
  
"end_at": "string",
  
  
  
"start_at_local": "string",
  
  
  
"end_at_local": "string",
  
  
  
"start_at_site": "string",
  
  
  
"end_at_site": "string",
  
  
  
"timezone": "string",
  
  
  
"venue_type": "string",
  
  
  
"venue": "string",
  
  
  
"address": "string",
  
  
  
"cover_url": "string",
  
  
  
"has_meeting_url": true,
  
  
  
"online_meeting_url": "string",
  
  
  
"entry_type": "string",
  
  
  
"guest_count": 0,
  
  
  
"capacity": "string",
  
  
  
"spots_left": "string",
  
  
  
"is_full": true,
  
  
  
"start_display": "string",
  
  
  
"is_past": true,
  
  
  
"my_status": "string",
  
  
  
"registration_open": true,
  
  
  
"register_nonce": "string",
  
  
  
"edit_url": "string",
  
  
  
"space_slug": "string",
  
  
  
"space": "string"
  
  
}
  
],
  
"total": 0,
  
"current_page": 0,
  
"last_page": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation