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

The Catalogs API from Coveo — 6 operation(s) for catalogs.

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

This API exposes 9 operations across 6 paths, and defines 18 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.

9 operations 6 paths 18 schemas 1 DELETE4 GET3 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 Catalogs 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 9

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

Catalogs 9
GET
/rest/organizations/{organizationId}/catalogs/{catalogId}
Show Catalog
getCatalog 2 params → 200
PUT
/rest/organizations/{organizationId}/catalogs/{catalogId}
Update Catalog
updateCatalog 2 params body → 200
DELETE
/rest/organizations/{organizationId}/catalogs/{catalogId}
Delete Catalog
deleteCatalog 2 params → 204400404
GET
/rest/organizations/{organizationId}/catalogs
List Catalogs
getCatalogs 9 params → 200
POST
/rest/organizations/{organizationId}/catalogs
Create Catalog
createCatalog 1 param body → 201
POST
/rest/organizations/{organizationId}/catalogs/ids
List Catalogs Using Catalog Ids as a Body for Filtering.
getCatalogsWithIdsBody 5 params body → 200
POST
/rest/organizations/{organizationId}/catalogs/fieldsSuggestions
Suggest Fields
getFieldsSuggestions 1 param body → 200
GET
/rest/organizations/{organizationId}/catalogs/{catalogId}/fieldStats
Show Field Stats
getFieldStats 3 params → 200
GET
/rest/organizations/{organizationId}/catalogs/project
List Catalogs Within Specified Project and According to the Specified Filter.
getCatalogsWithProjectId 9 params → 200

Schemas 18

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

CatalogModel
object
The retrieved page of items.
8 properties 3 required
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
CreateCatalogModel
object
The [catalog](https://docs.coveo.com/en/3143/) to update.
7 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
FieldsSuggestionsModel
object
1 property
CreateCatalogV1Model
object
The [catalog](https://docs.coveo.com/en/3143/) to create.
6 properties 2 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
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
CommercePageModelCatalogModel
object
Page
3 properties 3 required
CachedFieldStats
object
3 properties 2 required
FieldStatsModel
object
Collection of statistics about the usage of fields by a catalog
4 properties
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
FieldsSuggestionsQueryModel
object
The fields suggestions query to be executed
5 properties 2 required
FieldSuggestionsModel
object
The list of fields suggestions.
3 properties
CatalogConfigurationModel
object
The catalog configuration.
7 properties 2 required
FieldStatsItemModel
object
Availability stats
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-catalogs-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 Catalogs 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.