API reference

Search

Content Delivery API: GET /search

Base URL https://{site}/api/v1Errors Pagination

GET/search

betaNo auth

qstring · queryrequired
kindstring · query
limitinteger · query
Maximum number of results, 1-20. Defaults to 20.
cursorstring · query
Opaque cursor from the previous page's nextCursor. Omit for the first page.
localestring · query
Locale to search. One of the site's locales from /site (a code such as `en-US` or the URL prefix such as `en`); omit it for the primary locale. Other values, including locales that are still translating, return 400 UNSUPPORTED_LOCALE. Titles, excerpts, snippets and `url` (with the locale's URL prefix) come from that locale's published translations; untranslated text stays in the primary locale. `resolvedLocale` in the response is the locale actually searched. A cursor only works with the same locale.
totalboolean · query
true adds total (the number of matching results across all pages) to the response, for a results count such as "12 results". It is counted in the same query as the results, so it adds no extra request.

dataobject[]required
hasMorebooleanrequired
True when another page exists; pass nextCursor to fetch it.
nextCursorstring | nullrequired
Cursor for the next page, or null on the last page.
qstringrequired
tokensstring[]required
resolvedLocalestring
Locale actually searched: the requested locale when it is one of the site's published locales, otherwise the primary locale.
totalinteger
Number of matching results across all pages. Present only when total=true.

curl -X GET "https://{site}/api/v1/search"