Coveo Listing 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 Listing 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
10 operations
across 6 paths,
and defines 43 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.
10 operations6 paths43 schemas1 DELETE6 GET1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Coveo Listing 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 10
Across 6 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Retrieves All Listing Configurations Ids & Names of an Organization. WILL BE DEPRECATED on 2026-08-31.
getAllNames5 params→ 200
Schemas 43
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are RankingRuleModel (9 properties), RuleItemModel (9 properties), ListingConfigurationModel (8 properties), PinRuleModel (8 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 properties2 required
AbstractFacetRequestModelObject
object
The facet operations to perform on the listing query.
6 properties2 required
ListingConfigurationModel
object
8 properties4 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 properties2 required
PaginatedRuleItems
object
3 properties3 required
CommercePageModelListingConfigurationNameModel
object
Page
3 properties3 required
RegularFacetRequestModel
object
Regular (single string value) facet.
2 required
CommercePageModelListingConfigurationModel
object
Page
3 properties3 required
FilterRuleItem
object
1 required
PinRuleItem
object
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 property1 required
RegularFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
3 properties1 required
NumericalRangeFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties2 required
FilterRuleModel
object
List of the filter rules.
8 properties1 required
MatchingConfigurationModel
object
Possible patterns matching values associated to a listing configuration.
1 property1 required
SortByRelevanceModel
object
SearchConditionModel
object
Search conditions associated to query-based rules on a search configuration.
2 properties2 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
ListingConfigurationNameModel
object
The retrieved page of items.
3 properties2 required
NumericalRangeFacetRequestModel
object
Numerical range facet.
2 required
SortByFieldModel
object
Defines the fields and, optionally, their sort order.
3 properties2 required
RankingRuleItem
object
1 required
SortByFieldsModel
object
1 required
RangeDomain
object
Limits the range values to the specified domain.
3 properties2 required
InclusiveRangeModel
object
1 required
RankingRuleModel
object
List of the ranking rules.
9 properties1 required
BasePath
object
List of localized Base path shared by all values for the facet.
2 properties2 required
RuleItemModel
object
The retrieved page of items.
9 properties
HierarchicalFacetRequestValueModel
object
The values displayed by the facet in the search interface at the moment of the request.
5 properties1 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 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Listing 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.
