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

The Organizations API from Coveo — 14 operation(s) for organizations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 24 operations across 14 paths, and defines 46 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.

24 operations 14 paths 46 schemas 4 DELETE10 GET6 POST4 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, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Coveo Organizations API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (platformTokens). It accepts HTTP bearer tokens (JWT) (searchTokens). It accepts HTTP bearer tokens (apiKey).

  • platformTokens — Platform tokens are used to authenticate requests to the platform as a specific user. See [Use platform token authentication](https://docs.coveo.com/en/n3ge002…
  • searchTokens — Search tokens are used to authenticate search-related API requests. See [Use search token authentication](https://docs.coveo.com/en/56).
  • apiKey — API keys are used to authenticate requests to the platform as a specific user. See [Use API key authentication with the Search API](https://docs.coveo.com/en/1…

Paths & Operations 24

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

Organizations 24
GET
/rest/organizations/{organizationId}
Show Organization
getOrganization 2 params → 200
PUT
/rest/organizations/{organizationId}
Update Organization
updateOrganization 1 param body → 204
DELETE
/rest/organizations/{organizationId}
Delete Organization
deleteOrganization 1 param → 204
PUT
/rest/organizations/{organizationId}/configuration/servingExperiment
Allow or Disallow Serving Experiments on the Organization. It Is Allowed by Default.
setServingExperiment 2 params → 204
GET
/rest/organizations
List Organizations
getOrganizations 7 params → 200
POST
/rest/organizations
Create Organization
createOrganization 3 params → 201
POST
/rest/organizations/{organizationId}/resume
Resume Organization
resumeOrganization 1 param → 200
POST
/rest/organizations/{organizationId}/launchprovisioning
Provision Organization
launchProvisioning 1 param → 204
GET
/rest/organizations/{organizationId}/status
Show Organization Status
getOrganizationStatus 1 param → 200
GET
/rest/organizations/{organizationId}/authentication
Lists All Authentication Providers for an Organization
listAuthentications 1 param → 200
GET
/rest/organizations/{organizationId}/authentication/saml
Lists the SAML Authentications for an Organization
listSamlAuthentications 1 param → 200
POST
/rest/organizations/{organizationId}/authentication/saml
Creates a New SAML Authentication in an Organization
createSamlAuthentication 1 param body → 200
GET
/rest/organizations/{organizationId}/authentication/saml/{id}
Loads a Single SAML Authentication from an Organization
loadSamlAuthentication 2 params → 200
PUT
/rest/organizations/{organizationId}/authentication/saml/{id}
Updates a SAML Authentication in an Organization
updateSamlAuthentication 2 params body → 200
DELETE
/rest/organizations/{organizationId}/authentication/saml/{id}
Deletes a SAML Authentication from an Organization
deleteSamlAuthentication 2 params → 200
GET
/rest/organizations/{organizationId}/authentication/sharepoint
List SharePoint Claims Authentication Providers
listSharepointClaimsAuthProvider 1 param → 200
POST
/rest/organizations/{organizationId}/authentication/sharepoint
Create SharePoint Claims Authentication Provider
createSharepointAuthenticationProvider 1 param body → 200201
GET
/rest/organizations/{organizationId}/authentication/sharepoint/{id}
Get SharePoint Claims Authentication Provider
getSharepointAuthenticationProvider 2 params → 200
PUT
/rest/organizations/{organizationId}/authentication/sharepoint/{id}
Update SharePoint Claims Authentication Provider
updateSharepointAuthenticationProvider 2 params body → 200204
DELETE
/rest/organizations/{organizationId}/authentication/sharepoint/{id}
Delete SharePoint Claims Authentication Provider
deleteSharepointAuthenticationProvider 2 params → 200204
GET
/rest/organizations/{organizationId}/authentication/trusteduris
List Trusted Search Page URIs
getTrustedUris 3 params → 200
POST
/rest/organizations/{organizationId}/authentication/trusteduris
Add Trusted Search Page URI
addTrustedUri 1 param body → 201
GET
/rest/organizations/{organizationId}/authentication/trusteduris/recentuntrusted
List Recently Seen Search Page URIs That Were Not Trusted.
getRecentUntrustedUris 3 params → 200
DELETE
/rest/organizations/{organizationId}/authentication/trusteduris/{id}
Delete Trusted Search Page URI
deleteTrustedUri 2 params → 200204

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are ApiKeyModel (28 properties), EntitlementModel_Response (22 properties), UserModel (21 properties), LicenseModel_Response (16 properties). Each schema is shown below with its type and property counts.

ValueModelBoolean
object
1 property
EntitlementModel_Response
object
A set of entitlements describing what the organization has access to.
22 properties
LightProvisioningStatusModel_Response
object
The provisioning status of the [organization](https://docs.coveo.com/en/185/). See [Understanding Organization Provisioning](https://docs.coveo.com/en/2547/).
5 properties
OrganizationOwnerModel_Response
object
The owner of the [organization](https://docs.coveo.com/en/185/).
1 property
ApiKeyAdditionalConfigurationModel
object
The additional configuration to attach to the API key.
3 properties
IdAndDisplayNameModel
object
2 properties
LicenseModel_Response
object
The organization license.
16 properties
UserRealmModel
object
The realms the user is a part of.
3 properties
ApiKeyExposureReportReasonResponse
object
Response containing the reason for API key exposure, it contain at least one of the reason or url
5 properties
EventModel
object
The user information to send along with usage analytics events.
2 properties
OrganizationConfigurationModel_Response
object
1 property
BusinessAnalyticsModel_Response
object
The organization business analytics settings.
3 properties
OrganizationStatusModel
object
The status of an [organization](https://docs.coveo.com/en/185/).
9 properties
EnforcedQueryPipelineConfigurationModel
object
The query pipeline configuration to enforce on the API key.
1 property
OrganizationModel_Request
object
An [organization](https://docs.coveo.com/en/185/).
2 properties
RealmModel
object
A realm.
4 properties
AnalyticsConfigurationModel
object
The user information to send to Coveo Usage Analytics
1 property
UserModel
object
A user.
21 properties
AllowedScheduleModel_Response
object
The schedule that is used by the [connector](https://docs.coveo.com/en/2734/).
2 properties
PageModelOrganizationModel_Response
object
3 properties
ApiKeyExposureReportResponse
object
An API key Exposure Report
7 properties
OrganizationOwnerModel_Request
object
The owner of the [organization](https://docs.coveo.com/en/185/).
1 property
PrivilegeModel
object
The [privilege](https://docs.coveo.com/en/228/) of a resource.
4 properties
OrganizationStatusModel_Response
object
The status of an [organization](https://docs.coveo.com/en/185/).
9 properties
OrganizationModel_Response
object
An [organization](https://docs.coveo.com/en/185/).
11 properties
ApiKeyModel
object
28 properties
ImpersonatedUserModel
object
The security identities to impersonate when authenticating queries with the API key. Note: If specified, the API key must have the IMPERSONATE privilege.
3 properties
LightProvisioningStatusModel
object
The provisioning status of the [organization](https://docs.coveo.com/en/185/). See [Understanding Organization Provisioning](https://docs.coveo.com/en/2547/).
5 properties
ConnectorInformationModel_Response
object
Information for a connector.
4 properties
CommerceApiKeyConfigurationModel
object
The commerce configuration to enforce on the queries using the API key.
1 property
ImpersonationRestrictionsModel
object
The security identities to impersonate when authenticating queries with the API key.
1 property
OrganizationCreatedModel
object
Information pertaining to the newly created organization model.
2 properties
MachineLearningModelInformationModel_Response
object
The Machine Learning Models configurations.
3 properties
SearchApiKeyConfigurationModel
object
The Search API configuration to enforce in the API key.
3 properties
TrustedUri
object
2 properties 2 required
OutgoingSharePointAuthentication
object
9 properties 9 required
IncomingSharePointAuthentication
object
6 properties 4 required
CreatedSamlAuthentication
object
1 property 1 required
CreateTrustedUriResponse
object
1 property 1 required
IncomingSamlAuthentication
object
6 properties 3 required
ListTrustedUriResponse
object
2 properties 2 required
ListRecentUntrustedUriResponse
object
2 properties 2 required
OutgoingSamlAuthentication
object
11 properties 8 required
OutgoingAuthentication
CreateTrustedUriRequest
object
1 property 1 required
CreatedSharePointAuthentication
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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