Use the Platform API

This is for:

The Platform API exposes services which let you create and manage a Coveo organization, and retrieve its corresponding limits, license, and login activity information.

In the Coveo Administration Console, the Settings (platform-ca | platform-eu | platform-au) page uses the Platform API extensively.

Note

All REST API string fields are case-sensitive unless otherwise specified. For example, search queries aren’t case-sensitive.

To keep behavior consistent across the Coveo Platform, the same value passed to different REST APIs must always be passed using the same case. For example, if the unique product identifier, such as ec_product_id, is passed to the Commerce API in lowercase, then it should also be passed to the Usage Analytics Write API in lowercase.

The articles in this section cover various Platform API use cases:

Retrieve the organization ID with the API
Get the organization license information
Get the organization limit status
Delete an organization

Interactive generated reference documentation is also available through the Swagger UI.