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

The Groups API from Coveo — 3 operation(s) for groups.

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

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

6 operations 3 paths 14 schemas 1 DELETE3 GET1 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 Groups 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 6

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

Groups 6
GET
/rest/organizations/{organizationId}/groups/{groupId}
Show Group Details
getGroup 2 params → 200
PUT
/rest/organizations/{organizationId}/groups/{groupId}
Update Group
updateGroup 3 params body → 204
DELETE
/rest/organizations/{organizationId}/groups/{groupId}
Delete Group
deleteGroup 2 params → 204
GET
/rest/organizations/{organizationId}/groups
List Groups
getGroups 1 param → 200
POST
/rest/organizations/{organizationId}/groups
Create Group
createGroup 3 params body → 201
GET
/rest/organizations/{organizationId}/groups/{groupId}/privileges/exclusive/me
List Privileges Granted by Group to Current User
getGroupExclusivePrivileges 2 params → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GroupModel_Response (11 properties), GroupModel_Request (10 properties), InviteModel_Response (8 properties), InviteModel_Request (8 properties). Each schema is shown below with its type and property counts.

IdAndDisplayNameModel_Request
object
2 properties
MemberModel_Request
object
A [member](https://docs.coveo.com/en/2873/).
6 properties
RealmModel_Response
object
A realm.
4 properties
MemberModel_Response
object
A [member](https://docs.coveo.com/en/2873/).
6 properties
InviteModel_Response
object
An invite.
8 properties
PrivilegeModel
object
The [privilege](https://docs.coveo.com/en/228/) of a resource.
4 properties
PrivilegeModel_Request
object
The [privilege](https://docs.coveo.com/en/228/) of a resource.
4 properties
JsonStringIdWrapper
object
1 property
InviteModel_Request
object
An invite.
8 properties
IdAndDisplayNameModel_Response
object
2 properties
GroupModel_Request
object
A [group](https://docs.coveo.com/en/2867/).
10 properties
PrivilegeModel_Response
object
The [privilege](https://docs.coveo.com/en/228/) of a resource.
4 properties
GroupModel_Response
object
A [group](https://docs.coveo.com/en/2867/).
11 properties
RealmModel_Request
object
A realm.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-groups-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 Groups 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.