Skip to content

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

GET
/events/{eventId}/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​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Path Parameters

eventId*

Event ID (fe_event_details.id).

Type
integer
Required
Minimum
1

Query Parameters

search

Matches guest name or email.

Type
string
status

Only guests with this status.

Type
string
Valid values
"going""not_going""checked_in""cancelled"
per_page

Items per page.

Type
integer
Example10
Minimum
1
Maximum
100
Default
20
page

Page number, starting at 1.

Type
integer
order_by

Column to sort by.

Type
string
Valid values
"id""name""email""status""created_at"
Example"name"
Default
"id"
order_type

Sort direction.

Type
string
Valid values
"ASC""DESC"
Example"ASC"
Default
"DESC"

Responses​

Success

application/json
JSON
{
  
"guests": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"id": 0,
  
  
  
  
"event_id": 0,
  
  
  
  
"name": "string",
  
  
  
  
"email": "string",
  
  
  
  
"user_id": "string",
  
  
  
  
"status": "string",
  
  
  
  
"source": "string",
  
  
  
  
"checked_in_at": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"avatar": "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
  
},
  
"counts": {
  
  
"all": 0,
  
  
"going": 0,
  
  
"not_going": 0,
  
  
"checked_in": 0,
  
  
"cancelled": 0
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation