Skip to main content
The Management API lets you automate everything you can do in the Doofinder Admin Panel — creating search engines, managing the data structure (indices), and pushing, updating, or deleting items. Version: v2

​
Base URL

Example: https://eu1-api.doofinder.com

​
Authentication

Supports both API Token and JWT Bearer token authentication:
See the Authentication guide for JWT signing details.

​
Endpoints Overview

Search Engines

CRUD operations on search engine configurations.

Indices

Manage the data types (indices) within a search engine.

Items

Push, update, delete, and query individual items.

Bulk Index Operations

Full index replacement via temporary indices for zero-downtime updates.

​
Search Engines

A search engine is the top-level container for your searchable data. It holds one or more indices and is identified by its hashid.

​
Indices

An index is a named collection of items within a search engine. Most stores have a product index; you can also have page, category, or any custom index name.

​
Items

Items are the individual records in an index (products, pages, etc.). Use these endpoints for real-time, incremental updates.

​
Bulk operations

Bulk endpoints accept up to 100 items per request. For large catalogues, split into batches:
Requests with more than 100 items will be rejected with 422 Unprocessable Entity. Always batch your payloads.

​
Bulk Index Operations

For full catalogue replacement (e.g. nightly sync), use the temporary index workflow. This pattern allows a complete index swap with zero search downtime:
1

Create a temporary index

POST /api/v2/search_engines/{hashid}/indices/{name}/temp/Creates a writable temporary index alongside the live one.
2

Push all items to the temporary index

Use the temp item endpoints (/temp/items/, /temp/items/_bulk) to write your full catalogue. These writes don’t affect the live search index.
3

Replace the live index

POST /api/v2/search_engines/{hashid}/indices/{name}/_replace_by_temp/Atomically swaps the live index with the temporary one. Users continue searching against the old index until the swap completes.
Alternatively, use the reindex workflow for more control:

​
API Limits

​
Item Structure

Items are schema-flexible — you can include any fields your search engine is configured to index. Some fields are commonly expected:
The fields indexed by your search engine are configured in the Admin Panel under Configuration → Search Engines → [engine]. Only configured fields are searchable and facetable.