Search

Search recipes, cookbooks, chefs, and authorized private shopping-list items

get/api/v1/search

Request

  • Base URL: https://spoonjoy.app
  • URL: https://spoonjoy.app/api/v1/search
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in cookie __session
    • OAuth 2 (authorization code, authorization URL https://spoonjoy.app/oauth/authorize, token URL https://spoonjoy.app/oauth/token, scopes: shopping_list:read)
    • OAuth 2 (authorization code, authorization URL https://spoonjoy.app/oauth/authorize, token URL https://spoonjoy.app/oauth/token, scopes: kitchen:read)

Query parameters

querystring

Search text. Without commas, every word must match. Commas separate alternatives: a result matching any of them is returned, ordered by how many alternatives it matches and then by relevance. At most 12 alternatives are used. When both query and q are sent, query wins.

qstring

Search-text alias for clients that conventionally use q, with the same comma-separated alternatives as query. Ignored when query is also present.

scope'all' | 'recipes' | 'cookbooks' | 'chefs' | 'shopping-list'

Global search scope. The legacy value shopping is accepted as shopping-list.

limitinteger

Page size from 1 to 50. Defaults to 20.

Headers

X-Request-Idstring

Optional client-generated request id. Spoonjoy echoes it in X-Request-Id and the REST envelope for logs, retries, and support.

Response

Success

okunknown required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.