search

Search media, playlists, screens and creatives

Search across media, playlists, screens, and creatives using the q query parameter. Supports bare terms, prefix matching with *, the operators AND, OR, and NOT, and column filters such as name:dashboard. Results are scoped to the current space.

Full-text search by name. Each list holds only kinds the caller may view (the others come back empty), best match first. A query under 2 characters returns empty lists.

Notes.

  • The route is gated by media.view (the route-registry description says screen.view): a key without media.view is refused even if it could see screens.
  • A failing index query is swallowed and returns an empty list for that kind, so an empty result is not proof of no match.
get/v1/search

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/search
  • Auth: HTTP bearer

Query parameters

qstring required

Search text (2+ characters). The last word matches as a prefix.

limitinteger

Hits per kind (default 10, max 20).

Response

Success.

Changes

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