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 Configurations API

The Search Configurations API from Coveo — 1 operation(s) for search configurations.

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

This API exposes 2 operations across 1 path, and defines 34 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.

2 operations 1 paths 34 schemas 1 GET1 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
Terms of Service
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Search Configurations 2
GET
/rest/organizations/{organizationId}/commerce/v2/configurations/search/global
Retrieves the Global Search Configuration for the Organization
getGlobal 2 params → 200
PUT
/rest/organizations/{organizationId}/commerce/v2/configurations/search/global
Update the Global Search Configuration for the Organization
updateGlobal 1 param body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are RankingRuleModel (9 properties), PinRuleModel (8 properties), FilterRuleModel (8 properties), SearchConfigurationModel (7 properties). Each schema is shown below with its type and property counts.

DateRangeFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 2 required
AbstractFacetRequestModelObject
object
The facet operations to perform on the listing query.
6 properties 2 required
PinRuleModel
object
List of the pin rules.
8 properties
HierarchicalFacetRequestModel
object
Hierarchical (tree-like) facet.
2 required
QueryFilterModel
object
A list of filters.
3 properties 2 required
RegularFacetRequestModel
object
Regular (single string value) facet.
2 required
RulesModel
object
Rules to apply at query time.
3 properties
DecimalValueModel
object
1 required
DateRangeFacetRequestModel
object
Date range facet.
2 required
RangeModel
object
2 properties
StringValueModel
object
1 required
FacetRequestModel
object
DEPRECATED ON 2026-08-31: The facet request configuration. See https://docs.coveo.com/en/q3cc0299/deprecations/legacy-commerce-api-facet-management-deprecation…
3 properties
FieldValueModel
object
The value to apply the operator on.
1 property 1 required
RegularFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
3 properties 1 required
NumericalRangeFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 2 required
FilterRuleModel
object
List of the filter rules.
8 properties 1 required
SortByRelevanceModel
object
SearchConditionModel
object
Search conditions associated to query-based rules on a search configuration.
2 properties 2 required
SeedRelativeValueModel
object
QueryConfigurationLegacyModel
object
Query configuration.
6 properties
MultipleStringValuesModel
object
1 required
RuleLocaleModel
object
The list of locales the synonym applies to. When empty, the synonym applies to all locales.
3 properties
NumericalRangeFacetRequestModel
object
Numerical range facet.
2 required
SortByFieldModel
object
Defines the fields and, optionally, their sort order.
3 properties 2 required
SortByFieldsModel
object
1 required
RangeDomain
object
Limits the range values to the specified domain.
3 properties 2 required
InclusiveRangeModel
object
1 required
SearchConfigurationModel
object
7 properties 2 required
RankingRuleModel
object
List of the ranking rules.
9 properties 1 required
BasePath
object
List of localized Base path shared by all values for the facet.
2 properties 2 required
HierarchicalFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 1 required
HierarchicMultiValueModel
object
1 required
AbstractSortModel
object
Determines the order in which to retrieve the results.
1 property
DisplayName
object
The display names of a field to sort by associated with its language.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-search-configurations-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 Configurations 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.