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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Coveo

Coveo Mappings API

The Mappings API from Coveo — 11 operation(s) for mappings.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 22 operations across 11 paths, and defines 8 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.

22 operations 11 paths 8 schemas 3 DELETE8 GET6 POST5 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
Coveo
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Mappings 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 22

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

Mappings 22
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings
Show Mapping Configuration
getMappingsConfiguration 2 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/mappings
Update Mapping Configuration
updateMappingsConfiguration 3 params body → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}
List Specific Mappings of Given Type
getMappingTypeSettings 3 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}
Update Specific Mappings of Given Type
updateMappingTypeSettings 4 params body → 200
DELETE
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}
Delete Specific Mappings of Given Type
deleteMappingType 4 params → 204
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules/{ruleId}
Show Specific Mapping Rule
getMappingTypeSettingsRule 4 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules/{ruleId}
Update Specific Mapping Rule
updateMappingTypeSettingsRule 5 params body → 200
DELETE
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules/{ruleId}
Delete Specific Mapping Rule
deleteMappingTypeSettingsRule 5 params → 204
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common
List Common Mappings
getCommonMappingSettings 2 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common
Update Common Mappings
updateCommonMappingSettings 3 params body → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules/{ruleId}
Show Common Mapping Rule
getCommonMappingSettingsRule 3 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules/{ruleId}
Update Common Mapping Rule
updateCommonMappingSettingsRule 4 params body → 200
DELETE
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules/{ruleId}
Delete Common Mapping Rule
deleteCommonMappingSettingsRule 4 params → 204
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types
List Specific Mappings
getMappingTypes 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types
Create Specific Mapping
addMappingTypes 3 params body → 201
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules
List Specific Mapping Rules of Given Type
getMappingTypeSettingRules 3 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/types/{typeId}/rules
Create Specific Mapping Rule of Given Type
addMappingTypeSettingRule 4 params body → 201
GET
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules
List Common Mapping Rules
getCommonMappingSettingsRules 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/common/rules
Create Common Mapping Rule
addCommonMappingSettingsRule 3 params body → 201
POST
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/update
Update Mapping Rules in Batch
updateMappingTypesBatch 3 params body → 201
POST
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/delete
Delete Mapping Rules in Batch
deleteMappingTypesBatch 3 params body → 201
POST
/rest/organizations/{organizationId}/sources/{sourceId}/mappings/batch/create
Create Mapping Rules in Batch
addMappingTypesBatch 3 params body → 201

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are BatchOperationResourceStatusModelTypedMappingSettingsModel (4 properties), BatchOperationProgressModelTypedMappingSettingsModel (3 properties), TypedMappingSettingsModel (3 properties), RuleModel (3 properties). Each schema is shown below with its type and property counts.

RuleModel
object
A [mapping](https://docs.coveo.com/en/217/) rule. See [Mapping Definition Examples](https://docs.coveo.com/en/66/).
3 properties
TypedMappingSettingsModel
object
A specific [mapping](https://docs.coveo.com/en/217/) (i.e., a mapping that applies only to a specified [item](https://docs.coveo.com/en/210/) type).
3 properties
CommonMappingSettingsModel
object
A JSON describing the common [mappings](https://docs.coveo.com/en/217/) to update.
1 property
MappingsConfigurationModel
object
A JSON describing the [mapping](https://docs.coveo.com/en/217/) configuration to add or update.
2 properties
BaseRuleModel
object
The common [mapping](https://docs.coveo.com/en/217/) rule to create.
2 properties
BatchOperationResourceStatusModelTypedMappingSettingsModel
object
4 properties
BatchOperationProgressModelTypedMappingSettingsModel
object
3 properties
BaseTypedMappingSettingsModelBaseRuleModel
object
A JSON describing the specific [mapping](https://docs.coveo.com/en/217/) to create.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-mappings-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
AE Profile APIs.io
Coveo Administration API - Version 15 API
AE Profile APIs.io
Coveo Advanced Model Configurations API
AE Profile APIs.io
Coveo Agent Configuration API API
AE Profile APIs.io
Coveo Agent Orchestration API API
AE Profile APIs.io
Coveo Analysis V3 API
AE Profile APIs.io
Coveo Analytics API - Version 14 API
AE Profile APIs.io
Coveo Analytics API - Version 15 API
AE Profile APIs.io
Coveo Answer API
AE Profile APIs.io
Coveo Api Keys API
AE Profile APIs.io
Coveo Atlassian Connect App API
AE Profile APIs.io
Coveo Badges API
AE Profile APIs.io
#Mappings
← Back to C APIs
API Details
ID
coveo:coveo-mappings-api
Base URL
https://platform.cloud.coveo.com
Docs
https://docs.coveo.com/en/124/
Provider
Coveo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=coveo-mappings-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-mappings-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Mappings 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.