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

Coveo Search Pages API

Manage Classic hosted search pages

Coveo Search Pages 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 Pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 17 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

17 operations 10 paths 15 schemas 3 DELETE5 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Search Pages API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the implicit flow, exposing 1 scope.

Paths & Operations 17

Across 10 paths, the API surfaces 17 operations — 3 DELETE, 5 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Search Pages 17

Manage Classic hosted search pages

GET
/rest/organizations/{organizationID}/pages
List Search Pages
2 params → 200400401500
POST
/rest/organizations/{organizationID}/pages
Create Search Page
1 param body → 201400401500
POST
/rest/organizations/{organizationID}/pages/ids
List Search Pages by Ids
1 param body → 200400401500
GET
/rest/organizations/{organizationID}/pages/project/id
List Pages by Project ID
2 params → 200400401500
GET
/rest/organizations/{organizationID}/pages/{pageID}
Get Search Page
2 params → 200400401500
PUT
/rest/organizations/{organizationID}/pages/{pageID}
Update Search Page Metadata
2 params body → 204400401500
DELETE
/rest/organizations/{organizationID}/pages/{pageID}
Delete a Search Page or in-App Widget
2 params → 204400401500
GET
/rest/organizations/{organizationID}/pages/{pageID}/header
Get Search Page Header
2 params → 200400401500
PUT
/rest/organizations/{organizationID}/pages/{pageID}/header
Reorder Resources in Search Page Header
2 params body → 200400401500
POST
/rest/organizations/{organizationID}/pages/{pageID}/header/css
Create CSS Resource in a Search Page Header
2 params body → 200400401500
PUT
/rest/organizations/{organizationID}/pages/{pageID}/header/css/{resourceName}
Update CSS Resource in Search Page Header.
3 params body → 200400401404500
DELETE
/rest/organizations/{organizationID}/pages/{pageID}/header/css/{resourceName}
Delete CSS Resource in Search Page Header.
3 params → 204400401404500
POST
/rest/organizations/{organizationID}/pages/{pageID}/header/javascript
Append JavaScript Resource to Search Page Header.
2 params body → 200400401500
PUT
/rest/organizations/{organizationID}/pages/{pageID}/header/javascript/{resourceName}
Update JavaScript Resource in Search Page Header.
3 params body → 200400401404500
DELETE
/rest/organizations/{organizationID}/pages/{pageID}/header/javascript/{resourceName}
Delete JavaScript Resource in Search Page Header.
3 params → 204400401404500
GET
/rest/organizations/{organizationID}/pages/{pageID}/searchui
Get Search Page JavaScript Search Framework Information
2 params → 200400401500
PUT
/rest/organizations/{organizationID}/pages/{pageID}/searchui
Change the JavaScript Search Framework Resources
4 params → 204400401500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are swaggermodels.ResponsePage (7 properties), swaggermodels.ResponseSearchUIUpgradeInfo (4 properties), swaggermodels.RequestUpdatePageMetadata (3 properties), swaggermodels.CSSResourceSharedModel (3 properties). Each schema is shown below with its type and property counts.

swaggermodels.CSSResourceSharedModel
object
3 properties
coveo_com_searchpages_pkg_http_rest_viewroutes_hostedsearchpages.aliasJavaScript
object
3 properties
coveo_com_searchpages_pkg_http_rest_viewroutes_hostedsearchpages.aliasCSS
object
3 properties
swaggermodels.ResponseApplicationErrorInternalServerError
object
2 properties
swaggermodels.UpdateHeaderResourcesModel
object
2 properties
swaggermodels.RequestCreateEmptyPage
object
2 properties
swaggermodels.ResponseSearchUIUpgradeInfo
object
4 properties
swaggermodels.JavaScriptResourceSharedModel
object
3 properties
swaggermodels.ResponseApplicationErrorBadRequest
object
2 properties
swaggermodels.ResponseApplicationErrorUnauthorized
object
2 properties
swaggermodels.ResponsePage
object
7 properties
swaggermodels.ResponseApplicationErrorNotFound
object
2 properties
swaggermodels.RequestUpdatePageMetadata
object
3 properties
swaggermodels.PageHeaderSharedModel
object
2 properties
swaggermodels.ResponseSearchUIVersion
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-search-pages-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Search Pages 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.