Global Search

Returns search results from the library, grouped by entity type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Matching is full text, so a query does not have to align to the start of a word:

  • Prefix: chick matches "chicken".
  • Infix: ken matches "chicken".

Results are sorted by relevance, most relevant first.

Each item carries a pk, and a detail_url where one exists, for fetching the item's full details.

Query Params
string

The search query string. If not provided, returns empty results.

string

Comma-separated list of entity types to search. Valid values: ingredients, recipes, images, albums, menus, recipe_albums, purchase_orders, stock_items, supplier_packages, invoices. If not provided, searches all entity types.

int32
Defaults to 1

A page number within the paginated result set. Starts at 1.

int32
≤ 200
Defaults to 15

Number of results per page. Maximum value is 200.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json