Box Developer Documentation
Log in

Metadata query index

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

A metadata query index

string
-9876

The ID of the metadata query index.

string
metadata_query_index

Value is always metadata_query_index

object array

A list of template fields which make up the index.

string
vendor name

The metadata template field key.

string
asc

The sort direction of the field.

Value is one of asc,desc

string
active

The status of the metadata query index

Value is one of building,active,disabled

Response Example

{
  "id": "-9876",
  "type": "metadata_query_index",
  "fields": [
    {
      "key": "vendor name",
      "sort_direction": "asc"
    }
  ],
  "status": "active"
}