List Guests
Returns the guests of one event, paginated, with a count per status for the tabs.
counts has all plus one key per status, each matching the current search. A status with no guests still reads 0. 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/{eventId}/guests - Controller:
GuestController@getGuests - Route source:
fluent-event/app/Http/Routes/api.php:60 - Controller source:
fluent-event/app/Http/Controllers/GuestController.php:14
Permissions
- Requires the
manage_optionscapability (a site administrator). FluentEvent has no separate staff roles: its admin API is for administrators only.
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 Guests
Returns the guests of one event, paginated, with a count per status for the tabs.
Controller: GuestController@getGuests
Route source: fluent-event/app/Http/Routes/api.php:60
Authorizations
A WordPress username and an Application Password.
Parameters
Path Parameters
Event ID (fe_event_details.id).
1Query Parameters
Matches guest name or email.
Only guests with this status.
"going""not_going""checked_in""cancelled"Items per page.
10110020Page number, starting at 1.
Column to sort by.
"id""name""email""status""created_at""name""id"Sort direction.
"ASC""DESC""ASC""DESC"Responses
Success