Skip to content

List Calendars ​

Returns every calendar with its event and guest counts, plus a count per status for the tabs.

Not paginated. counts ignores the status filter and follows search, so the tabs always show every status.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/calendars
  • Controller: CalendarController@getAllCalendars
  • Route source: fluent-event/app/Http/Routes/api.php:37
  • Controller source: fluent-event/app/Http/Controllers/CalendarController.php:12

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 Calendars​

GET
/calendars

Returns every calendar with its event and guest counts, plus a count per status for the tabs.

Controller: CalendarController@getAllCalendars
Route source: fluent-event/app/Http/Routes/api.php:37

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Query Parameters

search

Matches title or slug.

Type
string
Example"meetup"
status

Only calendars with this status.

Type
string
Valid values
"public""private""draft"
order_by

Column to sort by.

Type
string
Valid values
"id""title""slug""status""created_at""updated_at"
Default
"id"
order_type

Sort direction.

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

Responses​

Success

application/json
JSON
{
  
"calendars": [
  
  
{
  
  
  
"id": 0,
  
  
  
"title": "string",
  
  
  
"slug": "string",
  
  
  
"description": "string",
  
  
  
"visibility": "string",
  
  
  
"status": "string",
  
  
  
"meta": {
  
  
  
  
"theme_color": "string"
  
  
  
},
  
  
  
"created_by": 0,
  
  
  
"created_at": "string",
  
  
  
"updated_at": "string",
  
  
  
"events_count": "string",
  
  
  
"guests_count": "string"
  
  
}
  
],
  
"counts": {
  
  
"all": 0,
  
  
"public": 0,
  
  
"draft": 0
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation