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

The Sources API from Coveo — 45 operation(s) for sources.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 55 operations across 45 paths, and defines 122 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.

55 operations 45 paths 122 schemas 4 DELETE21 GET24 POST6 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
Resource Areas
1

Authentication & Security 1

Coveo Sources API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit flow, exposing 1 scope.

  • oauth2 — OAuth2

Paths & Operations 55

Across 45 paths, the API surfaces 55 operations — 4 DELETE, 21 GET, 24 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Sources 55
POST
/rest/organizations/{organizationId}/schema/sources/SLACK/validateToken
Validates a Slack OAuth Token
validateSlackToken 3 params → 200
GET
/rest/organizations/{organizationId}/schema/sources/{sourceType}/defaultObjectsToGet
Retrieves the Default Objects for a Source of Type Specified.
getDefaultObjectsToGet 2 params → 200
GET
/rest/organizations/{organizationId}/schema/sources/{sourceType}/entities
Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names.
getSchemaEntities 13 params → 200
GET
/rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}
Retrieves the Entity Specified with Its Fields.
getSchemaEntity 10 params → 200
GET
/rest/organizations/{organizationId}/schema/sources/{sourceType}/entities/{entityId}/fields
Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names.
getSchemaEntityFields 9 params → 200
POST
/rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/generic
Computes the Generic Objects to Get from a Specific Objects to Get.
translateToGeneric 2 params body → 200
POST
/rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specific
Computes the Specific Objects to Get from a Generic Objects to Get.
translateToSpecific 2 params body → 200
POST
/rest/organizations/{organizationId}/schema/sources/{sourceType}/translate/specificWithMappings
Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description
translateToSpecificWithMappings 9 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}
Get a Single Source
getSource 2 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}
Update a Source from Simple Configuration
updateSource 4 params body → 200
DELETE
/rest/organizations/{organizationId}/sources/{sourceId}
Delete a Source
deleteSource 2 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId}
Get a Source Schedule
getSourceSchedule 3 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId}
Update a Source Schedule
updateSourceSchedule 3 params body → 201
DELETE
/rest/organizations/{organizationId}/sources/{sourceId}/schedules/{scheduleId}
Delete a Source Schedule
deleteSourceSchedule 3 params → 204
GET
/rest/organizations/{organizationId}/sources/{sourceId}/raw
Get the Raw Configuration of a Source
getRawSource 3 params → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/raw
Update a Source from Raw Configuration
updateRawSource 4 params body → 200
PUT
/rest/organizations/{organizationId}/sources/{sourceId}/permissions/update
Update Source Permissions
updateSourcePermissions 2 params body → 200
GET
/rest/organizations/{organizationId}/sources/fields/{fieldId}
Get a Single Field for an Organization
getField 3 params → 200
PUT
/rest/organizations/{organizationId}/sources/fields/{fieldId}
Update a Field for an Organization
updateField 2 params body → 204
DELETE
/rest/organizations/{organizationId}/sources/fields/{fieldId}
Removes a Specific Field from an Organization
removeField 2 params → 204
PUT
/rest/organizations/{organizationId}/sources/fields/batch/update
Update a Field for an Organization
updateFields 1 param body → 204
GET
/rest/organizations/{organizationId}/sources
Get a Subset of Sources for an Organization
getSources 12 params → 200
POST
/rest/organizations/{organizationId}/sources
Create a Source from Simple Configuration
createSource 3 params body → 201
POST
/rest/organizations/{organizationId}/sources/{sourceId}/tasks/abort
Abort a Source Task Related to a Given Activity.
abortTaskForActivity 3 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/stopRefresh
Stop the Current Refresh Operation on a Source
stopRefresh 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/startRefresh
Start a Refresh Operation on a Source
startRefresh 2 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/schedules
Get All Source Schedules
getSourceSchedules 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/schedules
Create a New Schedule for the Source
createSourceSchedule 2 params body → 201
POST
/rest/organizations/{organizationId}/sources/{sourceId}/resumeRefresh
Resume the Current Refresh Operation on a Source
resumeRefresh 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/rebuild
Apply a Rebuild Operation on a Source
rebuild 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/pushRefresh
Sets the Refreshing State of a Push Source
setPushRefreshStatus 3 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/pauseRefresh
Pause the Current Refresh Operation on a Source
pauseRefresh 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/incrementalRefresh
Apply an Incremental Refresh Operation on a Source
incrementalRefresh 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/fullRefresh
Apply a Full Refresh Operation on a Source
fullRefresh 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/enabledeprecated
Enable Schedules on a Source
enable 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/duplicate
Duplicate a Source
duplicateSource 4 params → 201
POST
/rest/organizations/{organizationId}/sources/{sourceId}/disabledeprecated
Disable Schedules on a Source
disable 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/evict
Evict the Salesforce Schema of a Source.
evictSchemaForSource 2 params → 200
POST
/rest/organizations/{organizationId}/sources/{sourceId}/applyChanges
Apply Pending Changes on a Source
applyChanges 2 params → 204
POST
/rest/organizations/{organizationId}/sources/raw
Create a Source from Raw Configuration
createRawSource 3 params body → 201
POST
/rest/organizations/{organizationId}/sources/pages/ids
Get a Page Containing a Subset of Sources by Ids for an Organization.
getSourcesAndPageInformationsByIds 12 params body → 200
GET
/rest/organizations/{organizationId}/sources/fieldsdeprecated
Get All Fields for an Organization
getFields_1 3 params → 200
POST
/rest/organizations/{organizationId}/sources/fields
Creates a Field for an Organization
createField 1 param body → 204
POST
/rest/organizations/{organizationId}/sources/fields/batch/create
Creates Fields for an Organization
createFields 1 param body → 204
GET
/rest/organizations/{organizationId}/sources/{sourceId}/light
Get a Single Source
getLightSource 2 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/snapshot
Get the Snapshot of the Source Configuration at the Provided Activity.
getSourceSnapshot 3 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}
Get an Object Fields for a Given Source.
getSalesforceObjectForSource 4 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/{relationshipName}
Get a Relationship for a Given Source and Object.
getSalesforceRelationshipsForSource 4 params → 200
GET
/rest/organizations/{organizationId}/sources/{sourceId}/configuration/salesforce/objects/{objectName}/fields
Get an Object Fields for a Given Source.
getSalesforceFieldsForSource 3 params → 200
GET
/rest/organizations/{organizationId}/sources/raw/all
Get the Raw Configuration of All Sources
getAllRawSources 4 params → 200
GET
/rest/organizations/{organizationId}/sources/pages
Get a Page Containing a Subset of Sources for an Organization.
getSourcesAndPageInformations 12 params → 200
GET
/rest/organizations/{organizationId}/sources/pages/project
Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and the Total Number of Pages
getSourcesAndPageInformationsProjectId 13 params → 200
GET
/rest/organizations/{organizationId}/sources/page/fields
Get a Page of Fields for an Organization
getFields_2 10 params → 200
GET
/rest/organizations/{organizationId}/sources/document/configuration/default
Get the Default Document Configuration
getDefaultDocumentConfiguration 2 params → 200
DELETE
/rest/organizations/{organizationId}/sources/fields/batch/delete
Removes Fields from an Organization
removeFields 2 params → 204

Schemas 122

The contract defines 122 schemas that model the data the API accepts and returns. The most detailed are DocumentProcessorConfig (42 properties), SourceFieldModel (30 properties), SourceModel (29 properties), RawSourceConfig (26 properties). Each schema is shown below with its type and property counts.

SalesforceParentRelationships
object
2 properties 2 required
SpecificObjectsToGet
object
SlackTokenValidationStatus
object
4 properties 1 required
SchemaEntity
object
5 properties 2 required
GenericObjectsToGet
object
1 property
SchemaField
object
5 properties 3 required
SalesforceChildRelationships
object
3 properties 2 required
SchemaEntities
object
2 properties 1 required
SalesforcePolymorphicRelationships
object
3 properties 3 required
GenericObject
object
5 properties 2 required
JValue
object
MicrosoftDynamicsObject
object
5 properties
Web2SourceModel
object
FieldMappingModel
object
3 properties
IdAndDisplayNameModel
object
2 properties
SecurityProviderModel
object
17 properties
BoxEnterprise2SourceModel
object
ItemsModificationPeriod
object
4 properties
PermissionSet
object
4 properties
ServiceNowSourceModel
object
NextOperation
object
2 properties
ParameterModel
object
2 properties
GenericRestSourceModel
object
DocumentProcessor
object
2 properties
AuthenticationFailedConfiguration
object
2 properties
SalesforceSitesSourceModel
object
SitemapSourceModel
object
ShopifySourceModel
object
JiveSourceModel
object
DocumentProcessorParameters
object
6 properties
FileSourceModel
object
SourceConfigSnapshotMappingModel
object
5 properties
FormInput
object
3 properties
LightSourceModel
object
7 properties
RawSourceConfig
object
26 properties
ExtendedConfig
object
16 properties
ExtendedDataFile
object
3 properties
PermissionLevel
object
2 properties
MicrosoftDynamicsFetchXmlQueries
object
1 property
SinglePermissionModel
object
9 properties
Jira2SourceModel
object
MicrosoftDynamicsRelation
object
5 properties
GetSourcesOutArgs
object
3 properties
SalesforceField
object
14 properties
DetailedSecurityIdentityModel
object
14 properties
MicrosoftDynamicsCondition
object
4 properties
Parameter
object
2 properties
MemoryLimits
object
3 properties
PushSourceModel
object
YouTubeSourceModel
object
ScheduleFrequency
object
6 properties
SalesforceCondition
object
4 properties
CascadingSecurityProvider
object
4 properties
SharePointSourceModel
object
Confluence2HostedSourceModel
object
CharsetDetectionHint
object
2 properties
DropboxForBusinessSourceModel
object
DocumentPermissionModel
object
The item [permission model](https://docs.coveo.com/en/225/). See [Permission Details Tab](https://docs.coveo.com/en/1712/permission-details-tab).
4 properties
LanguageHint
object
2 properties
SourceExtensionModel
object
An [extension](https://docs.coveo.com/en/206/) configuration.
6 properties
Confluence2SourceModel
object
ConditionNode
object
FormAuthStep
object
6 properties
CustomSourceModel
object
AddressPattern
object
3 properties
SitecoreSourceModel
object
ExtensionSettingByExtension
object
2 properties
SourceModel
object
29 properties
KhorosSourceModel
object
UrlFilter
object
3 properties
SourceLastOperation
object
13 properties
MicrosoftDynamicsFetchXmlQuery
object
3 properties
FormAuthenticationConfig
object
14 properties
DatabaseSourceModel
object
SourceFieldModel
object
A [field](https://docs.coveo.com/en/200/).
30 properties
ExtensionSetting
object
14 properties
ExtensionSettings
object
4 properties
ZendeskSourceModel
object
SourceConfigSnapshotModel
object
2 properties
DocumentProcessorConfig
object
42 properties
MicrosoftDynamicsConditions
object
1 property
UserIdentityModel
object
3 properties
CatalogSourceModel
object
Jira2HostedSourceModel
object
PermissionSetModel
object
3 properties
CustomLoginSequence
object
5 properties
FormAction
object
4 properties
PostLoginSequence
object
5 properties
AmazonS3SourceModel
object
SecurityIdentityInfoModel
object
2 properties
SalesforceObject
object
13 properties
ScheduleModel
object
8 properties
Config
object
15 properties
MappingModel
object
8 properties
GoogleDriveDomainWideSourceModel
object
SecurityProvider
object
2 properties
SAPSourceModel
object
SecurityProviderReferenceModel
object
3 properties
FormElementIdentifier
object
3 properties
ConfigurationError
object
2 properties
PermissionModel
object
1 property
PermissionModelStateRootCauseModel
object
2 properties
UserIdentity
object
3 properties
RSSSourceModel
object
HourMinutePair
object
2 properties
SourceStatus
object
17 properties
SourceInformation
object
11 properties
Permission
object
4 properties
GraphQlSourceModel
object
SalesforceRelationship
object
7 properties
SharePointOnline2SourceModel
object
SalesforceInConditionValue
object
2 properties
DataFile
object
2 properties
DocumentConfig
object
8 properties
JiveHostedSourceModel
object
SourcePermissionsUpdateModel
object
2 properties
MicrosoftDynamicsSourceModel
object
SalesforceSourceModel
object
MetafieldConfiguration
object
3 properties
SlackSourceModel
object
PermissionLevelModel
object
The [permission levels](https://docs.coveo.com/en/225/).
2 properties
PageModelSourceFieldModel
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-sources-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
#Sources
← Back to C APIs
API Details
ID
coveo:coveo-sources-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-sources-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/coveo-sources-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 Sources 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.