Use the Field API

This is for:

The Field API exposes services which let you manage fields in the index of a Coveo organization.

In the Coveo Administration Console, the Fields (platform-ca | platform-eu | platform-au) page uses the Source 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 Field API use cases:

Create fields with the API
Available boolean field options

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