Skip to content

Search Pages ​

Searches published pages for a page setting, and says whether each page already holds the right shortcode or block.

Returns at most 50 pages, by title.

Endpoint ​

  • Method: GET
  • Path: /fluent-event/v2/settings/pages
  • Controller: SettingsController@getPages
  • Route source: fluent-event/app/Http/Routes/api.php:25
  • Controller source: fluent-event/app/Http/Controllers/SettingsController.php:61

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.

Search Pages​

GET
/settings/pages

Searches published pages for a page setting, and says whether each page already holds the right shortcode or block.

Controller: SettingsController@getPages
Route source: fluent-event/app/Http/Routes/api.php:25

Authorizations​

ApplicationPasswords

A WordPress username and an Application Password.

Type
HTTP (basic)

Parameters​

Query Parameters

key*

The page setting.

Type
string
Required
Valid values
"events_page_id"
Example"events_page_id"
Default
""
search

Matches the page title or content.

Type
string
Example"events"
Default
""

Responses​

Success

application/json
JSON
{
  
"pages": [
  
  
{
  
  
  
"id": 0,
  
  
  
"title": "string",
  
  
  
"link": "string",
  
  
  
"has_shortcode": true
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

FluentEvent developer documentation