Skip to content

Get Calendar ​

Returns one calendar with its creator's name and its event and guest totals.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/calendars/{id}
  • Controller: CalendarController@getCalendar
  • Route source: fluent-event/app/Http/Routes/api.php:39
  • Controller source: fluent-event/app/Http/Controllers/CalendarController.php:60

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.

Get Calendar​

GET
/calendars/{id}

Returns one calendar with its creator's name and its event and guest totals.

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

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Path Parameters

id*

Record ID.

Type
integer
Required
Minimum
1

Responses​

Success

application/json
JSON
{
  
"calendar": {
  
  
"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",
  
  
"creator_name": "string"
  
},
  
"stats": {
  
  
"total_events": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"upcoming_events": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"total_guests": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
},
  
  
"checked_in_guests": {
  
  
  
"title": "string",
  
  
  
"icon": "string",
  
  
  
"amount": 0,
  
  
  
"is_number": true
  
  
}
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation