Skip to main content
GET
List

Authorizations

Authorization
string
header
default:Token <your_api_key>
required

Doofinder API key. The Token prefix is part of the header value, so enter it too — the field is sent verbatim as:

Path Parameters

hashid
string
required

Unique id of a search engine.

Pattern: ^[a-f0-9]{32}$

Response

Indices retrieved.

name
string
required

Name of the Index. It works as the index identifier.

Pattern: ^[a-z][a-z0-9_]*$
Example:

"product"

preset
enum<string>
required

Preset of the index. The preset defines a set of configuration parameters for the index like basic fields to be included, and field transformations. For instance, the product preset creates the best_price field.

Available options:
generic,
product,
page,
category
Example:

"product"

options
Index Options · object

Accepted for backwards compatibility but ignored.

datasources
Data Source · object[]

List of datasources of an index.