getSearchAdmin BFF

/bff/search/

Runs every module-level search in parallel, applies scoring + snippet + highlighting, and returns the sorted top 100 in one JSON payload. Use this for the full search-results page, batch consumers, and the MCP server — anything that needs the final ranked list before it can render.

For the admin autocomplete UX, prefer GET /search/stream: it emits per-module buckets as they resolve so the first result is visible in ~50–300 ms instead of waiting for the slowest module (~800–1000 ms cold on large organisations).

The query is recorded to search__search_query + cas__organisation_search_log before the search runs, so user intent is captured even when the search itself times out.

SearchgetBffSearch

Parameters

3 query

Query parameters

· 3

querystringOptional

Search query string.

Exampleinvoice

localestringOptional

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

en-GB vs. en-US (British vs. American spelling)
pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendict → en-GB → en (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 2–35

Examplecs

categorystringOptional

Limit search to a specific result type (e.g. order, product, contact).

Exampleorder

Response schema

1 status code documented

200Success

querystringRequired

Normalized search query.

itemsobject[]Required

Each array item:

typestringRequired

Result entity type (order, product, contact, post, etc.).

Exampleorder

labelstringRequired

Display label of the result.

descriptionstringOptional

Additional context or subtitle.

urlstringOptional

Link to the result detail page.

scorenumberRequired

Relevance score (higher = better match).

Response example

application/json

{
  "query": "example_query",
  "items": [
    {
      "type": "order",
      "label": "example_label",
      "description": "example_description",
      "url": "example_url",
      "score": 0
    }
  ]
}

Request example

GET /bff/search/

get

curl -X GET "https://api.bizkithub.com/bff/search/?query=invoice&locale=cs&category=order" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key