How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coveo

Coveo Search Page Configuration API

The Search Page Configuration API from Coveo — 8 operation(s) for search page configuration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Coveo Search Page Configuration API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Search Page Configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 14 operations across 8 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

14 operations 8 paths 8 schemas 1 DELETE6 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
support@coveo.com
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Search Page Configuration API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — This API uses OAuth 2 with the implicit grant flow

Paths & Operations 14

Across 8 paths, the API surfaces 14 operations — 1 DELETE, 6 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Search Page Configuration 14
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces
Get All Search Page Interfaces
get-all-search-page-interfaces 5 params → 200
POST
/rest/organizations/{organizationId}/searchpage/v1/interfaces
Create a Search Page Interface
create-search-page-interface 1 param body → 201
GET
/organizations/{organizationId}/searchpage/v1/projects/interfaces
Get Project Search Page Interfaces
get-project-search-page-interfaces 6 params → 200
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}
Get a Search Page Interface
get-search-page-interface 2 params → 200404
PUT
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}
Update a Search Page Interface
update-search-page-interface 2 params body → 200404
DELETE
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}
Delete a Search Page Interface
delete-search-page-interface 2 params → 204404
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses
Get a Search Page Interface's Access Configuration
get-search-page-interface-access 2 params → 200404
PUT
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses
Update a Search Page Interface's Access Configuration
update-search-page-interface-access 2 params body → 200404
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses/users
Get the List of Users with Access to the Search Page.
get-search-page-interface-user-access 2 params → 200404
PUT
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses/users
Update the List of Users with Access to a Search Page.
update-search-page-interface-user-access 2 params body → 200404
POST
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/accesses/users
Add a Search Page Interface User Access
add-search-page-interface-user-access 3 params body → 200
POST
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/access/request
Request Search Page Interface Access
request-search-page-interface-access 2 params → 204400404
POST
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/preview
Preview Search Page Interface
preview-search-page-interface 2 params body → 200404401
GET
/rest/organizations/{organizationId}/searchpage/v1/interfaces/{interfaceId}/pipelines
Get Search Page Interface Pipelines
get-search-page-interface-pipelines 2 params → 200404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are search-page-interface-config-id (13 properties), search-page-interface-config (8 properties), pipeline-status (5 properties), interface-access (4 properties). Each schema is shown below with its type and property counts.

pipelines-status
array
A list containing the pipeline(s) used by the interface.
search-page-interface-config
object
8 properties 1 required
interface-add-user
object
2 properties
pipeline-status
object
The status of a pipeline.
5 properties
search-page-interface-config-id
object
13 properties 2 required
search-page-interface-config-project
interface-user-list
array
The list of users that are allowed to access the search interface.
interface-access
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-search-page-configuration-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
AE Profile APIs.io
Coveo Administration API - Version 15 API
AE Profile APIs.io
Coveo Advanced Model Configurations API
AE Profile APIs.io
Coveo Agent Configuration API API
AE Profile APIs.io
Coveo Agent Orchestration API API
AE Profile APIs.io
Coveo Analysis V3 API
AE Profile APIs.io
Coveo Analytics API - Version 14 API
AE Profile APIs.io
Coveo Analytics API - Version 15 API
AE Profile APIs.io
Coveo Answer API
AE Profile APIs.io
Coveo Api Keys API
AE Profile APIs.io
Coveo Atlassian Connect App API
AE Profile APIs.io
Coveo Badges API
AE Profile APIs.io
#Search Page Configuration
← Back to C APIs
API Details
ID
coveo:coveo-search-page-configuration-api
Base URL
https://platform.cloud.coveo.com
Docs
https://docs.coveo.com/en/124/
Provider
Coveo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coveo-search-page-configuration-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-search-page-configuration-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Coveo Search Page Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.