Use the Index API

This is for:

Developer System Administrator

The Index API exposes services which let you retrieve the permission model and effective permissions of any given item in the index of a Coveo organization.

In the Coveo Administration Console, the Content Browser (platform-ca | platform-eu | platform-au) uses the Index API when showing an item’s permission properties.

You can also use the Index API to view the effective permissions of an item.

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.

Interactive generated reference documentation is also available through Swagger UI.