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

The Catalog Configurations API from Coveo — 3 operation(s) for catalog configurations.

Coveo Catalog 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 Catalog 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 6 operations across 3 paths, and defines 13 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.

6 operations 3 paths 13 schemas 1 DELETE3 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 Catalog 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 6

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

Catalog Configurations 6
GET
/rest/organizations/{organizationId}/catalogconfigurations/{configurationId}
Show Catalog Configuration
getCatalogConfiguration 2 params → 200
PUT
/rest/organizations/{organizationId}/catalogconfigurations/{configurationId}
Update Catalog Configuration
updateCatalogConfiguration 2 params body → 200
DELETE
/rest/organizations/{organizationId}/catalogconfigurations/{configurationId}
Delete Catalog Configuration
deleteCatalogConfiguration 2 params → 204
GET
/rest/organizations/{organizationId}/catalogconfigurations
List Catalog Configurations
getCatalogConfigurations 3 params → 200
POST
/rest/organizations/{organizationId}/catalogconfigurations
Create Configuration
createCatalogConfiguration 1 param body → 201
GET
/rest/organizations/{organizationId}/catalogconfigurations/source/{sourceId}
Show Catalog Configuration from a Source ID
getCatalogConfigurationFromSource 2 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CatalogConfigurationModelWithAssociatedCatalogs (8 properties), CreateCatalogConfigurationModel (7 properties), CatalogConfigurationModel (7 properties), CreateCatalogConfigurationV1Model (6 properties). Each schema is shown below with its type and property counts.

VariantHierarchyModel
object
[Deprecated - use configuration.variant instead]. The configuration that allows indexed [items](https://docs.coveo.com/210/) representing distinct variants in…
3 properties 2 required
CreateCatalogConfigurationModel
object
The catalog configuration to update.
7 properties 2 required
CreateProductHierarchyModel
object
[Deprecated - use configuration.product instead]. The configuration that allows indexed [items](https://docs.coveo.com/210/)representing distinct products in t…
2 properties 2 required
ProductHierarchyModel
object
[Deprecated - use configuration.product instead]. The configuration that allows indexed [items](https://docs.coveo.com/210/)representing distinct products in t…
3 properties 2 required
CreateAvailabilityHierarchyModel
object
[Deprecated - use configuration.availability instead]. The configuration that allows indexed [items](https://docs.coveo.com/210/) representing distinct variant…
3 properties 2 required
CatalogIdentityModelWithSources
object
The catalogs associated to the configuration
4 properties 1 required
CreateVariantHierarchyModel
object
[Deprecated - use configuration.variant instead]. The configuration that allows indexed [items](https://docs.coveo.com/210/) representing distinct variants in…
2 properties 2 required
CommercePageModelCatalogConfigurationModelWithAssociatedCatalogs
object
Page
3 properties 3 required
CreateCatalogConfigurationV1Model
object
The catalog configuration to create.
6 properties 2 required
AvailabilityHierarchyModel
object
[Deprecated - use configuration.availability instead]. The configuration that allows indexed [items](https://docs.coveo.com/210/) representing distinct variant…
4 properties 2 required
CatalogConfigurationModel
object
The catalog configuration.
7 properties 2 required
CatalogConfigurationModelWithAssociatedCatalogs
object
8 properties 2 required
CatalogIdAndConfigurationModel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-catalog-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 Catalog 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.