Search API Routes

Search the entities that have a search index and are registered as search entities in the Medusa Admin dashboard.

GET /admin/search#

Search Admin

Search entities that have a search index and are defined as search entities in the Medusa Admin.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Query parameters

qstringOptional

A query to run full-text search against the search index.

entitystring[]Optional

The entities to run the search against.

limitnumberOptional

Limit the number of items returned in the list.

offsetnumberOptional

The number of items to skip when retrieving a list.

Request examples

Responses

200 OK

resultsobject[]

The search results for each entity, in the order the entities were requested.

400, 401, 404, 409, 422, 500: an error response is returned.

Found a problem with this page?Report Issue

Edited Nov 14·Edit this page