Appearance
Index Admin API
Read-only observability for the search engine (Meilisearch). These endpoints power the Admin → Index page and are intended for troubleshooting indexing. All routes require manage:all (Super Administrator) permission and expose only GET methods — the API key of the search engine is never returned.
Get Overview
Returns instance-level information (host, version, health, database size), metadata for the emails index (document count, primary key, indexing state, field distribution), and per-ingestion-source document counts taken directly from the search index's facet distribution — not the database.
Search engine overview
GET
/v1/index-admin/overview
Returns Meilisearch instance info (host, version, health, database size) and the emails index metadata (document count, primary key, indexing state, field distribution). Read-only. Requires manage:all (Super Admin) permission.
Authorizations
bearerAuth
JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.
Type
HTTP (bearer)
or
apiKeyAuth
API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.
Type
API Key (header: X-API-KEY)
Responses
Search engine overview.
Get Tasks
Returns a cursor-paginated list of Meilisearch tasks for the emails index (e.g. documentAdditionOrUpdate), including status, received/indexed document counts, duration, timestamps, and any error. Filter with statuses and types, and page with limit + from (use the next cursor from the previous response).
Search engine task list
GET
/v1/index-admin/tasks
Returns a cursor-paginated list of Meilisearch tasks for the emails index, optionally filtered by status/type. Read-only. Requires manage:all (Super Admin) permission.
Authorizations
bearerAuth
JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.
Type
HTTP (bearer)
or
apiKeyAuth
API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.
Type
API Key (header: X-API-KEY)
Parameters
Query Parameters
limit
Type
integer
Default
20from
Cursor (task uid) to page from.
Type
integer
statuses
Comma-separated statuses (enqueued,processing,succeeded,failed,canceled).
Type
string
types
Comma-separated task types.
Type
string
Responses
Paginated task list.