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

The Query Configurations API from Coveo — 1 operation(s) for query configurations.

Coveo Query 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 Query 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 4 operations across 1 path, and defines 20 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.

4 operations 1 paths 20 schemas 1 DELETE1 GET1 POST1 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 Query 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 4

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

Query Configurations 4
GET
/rest/organizations/{organizationId}/commerce/v2/configurations/query
Get Query Configuration for a Solution
get_1 5 params → 200
PUT
/rest/organizations/{organizationId}/commerce/v2/configurations/query
Update Query Configuration for a Solution
update_1 1 param body → 200
POST
/rest/organizations/{organizationId}/commerce/v2/configurations/query
Create Query Configuration for a Solution
create 1 param body → 201
DELETE
/rest/organizations/{organizationId}/commerce/v2/configurations/query
Delete the Query Configuration of a Solution
delete_1 5 params → 204

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are QueryConfigurationModel (6 properties), AbstractFacetRequestModelObject (6 properties), HierarchicalFacetRequestValueModel (5 properties), QueryConfigurationRequestModel (5 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
QueryConfigurationRequestModel
object
Request for editing query configurations.
5 properties 3 required
HierarchicalFacetRequestModel
object
Hierarchical (tree-like) facet.
2 required
RegularFacetRequestModel
object
Regular (single string value) facet.
2 required
DateRangeFacetRequestModel
object
Date range facet.
2 required
QueryConfigurationModel
object
Query configuration.
6 properties
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
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
SortByRelevanceModel
object
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
BasePath
object
List of localized Base path shared by all values for the facet.
2 properties 2 required
QueryParamGroupingOverridesConfigModel
object
The product grouping. Determines if pin rules should consider results to be grouped on the query pipeline, or not.
1 property 1 required
HierarchicalFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties 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-query-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 Query 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.