Skip to content

List Calendar Options ​

Returns calendars as dropdown options: ID, title, status and meta only, with no counts.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/calendars/options
  • Controller: CalendarController@getCalendarOptions
  • Route source: fluent-event/app/Http/Routes/api.php:38
  • Controller source: fluent-event/app/Http/Controllers/CalendarController.php:46

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 Calendar Options​

GET
/calendars/options

Returns calendars as dropdown options: ID, title, status and meta only, with no counts.

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

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"
Example"title"
Default
"id"
order_type

Sort direction.

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

Responses​

Success

application/json
JSON
{
  
"calendars": [
  
  
{
  
  
  
"id": 0,
  
  
  
"title": "string",
  
  
  
"status": "string",
  
  
  
"meta": {
  
  
  
  
"theme_color": "string"
  
  
  
}
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation