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

The Subscription API from Coveo — 10 operation(s) for subscription.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

16 operations 10 paths 6 schemas 2 DELETE4 GET4 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
Contact
Coveo
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Coveo Subscription 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 16

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

Subscription 16
GET
/rest/organizations/{organizationId}/subscriptions/{subscriptionId}
Show Subscription
getSubscriptionById 2 params → 200
PUT
/rest/organizations/{organizationId}/subscriptions/{subscriptionId}
Update Subscription
editSubscription 2 params body → 200
DELETE
/rest/organizations/{organizationId}/subscriptions/{subscriptionId}
Delete Subscription
deleteSubscriptionById 2 params → 204
PUT
/rest/organizations/{organizationId}/subscriptions/{subscriptionId}/enable
Enable Subscription
enableSubscriptionById 2 params → 204
PUT
/rest/organizations/{organizationId}/subscriptions/{subscriptionId}/disable
Disable Subscription
disableSubscriptionById 2 params → 204
GET
/rest/organizations/{organizationId}/subscriptions/me/{subscriptionId}
Show Subscription for Current Member
getCurrentUserSubscriptionById 2 params → 200
PUT
/rest/organizations/{organizationId}/subscriptions/me/{subscriptionId}
Update Subscription for Current Member
editSubscriptionForCurrentUser 2 params body → 200
DELETE
/rest/organizations/{organizationId}/subscriptions/me/{subscriptionId}
Delete Subscription for Current Member
deleteCurrentUserSubscriptionById 2 params → 204
PUT
/rest/organizations/{organizationId}/subscriptions/me/{subscriptionId}/enable
Enable Subscription for Current Member
enableUserSubscriptionById 2 params → 204
PUT
/rest/organizations/{organizationId}/subscriptions/me/{subscriptionId}/disable
Disable Subscription for Current Member
disableUserSubscriptionById 2 params → 204
GET
/rest/organizations/{organizationId}/subscriptions
List Subscriptions
getSubscriptions 1 param → 200
POST
/rest/organizations/{organizationId}/subscriptions
Create Subscription
createSubscription 1 param body → 201
POST
/rest/organizations/{organizationId}/subscriptions/{subscriptionId}/test
Test Subscription
testSubscription 2 params → 204
GET
/rest/organizations/{organizationId}/subscriptions/me
List Subscriptions for Current Member
getCurrentUserSubscriptions 1 param → 200
POST
/rest/organizations/{organizationId}/subscriptions/me
Create Subscription for Current Member
createSubscriptionForCurrentUser 1 param body → 201
POST
/rest/organizations/{organizationId}/subscriptions/me/{subscriptionId}/test
Test Subscription for Current Member
testSubscriptionForCurrentUser 2 params → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SubscriptionModel (15 properties), EditSubscriptionModel (7 properties), SubscriptionPatternModel (5 properties), SubscriptionParametersModel (5 properties). Each schema is shown below with its type and property counts.

EditSubscriptionModel
object
The new configuration to update the [subscription](https://docs.coveo.com/en/248/) to.
7 properties
SubscriptionStatusModel
object
The [status of the subscription](https://docs.coveo.com/en/1583/manage-an-organization/manage-organization-notificationssubscription-status). See [Review the u…
3 properties
SubscriptionStatisticsModel
object
The usage statistics of a [subscription](https://docs.coveo.com/en/248/).
4 properties
SubscriptionParametersModel
object
Parameters specifying the [notification](https://docs.coveo.com/en/221/) sent by the [subscription](https://docs.coveo.com/en/248/).
5 properties
SubscriptionModel
object
A [subscription](https://docs.coveo.com/en/248/).
15 properties
SubscriptionPatternModel
object
The [subscription](https://docs.coveo.com/en/248/) configuration specifying which activities trigger notifications.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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