---
title: "Search media, playlists, screens and creatives"
method: GET
path: "/v1/search"
tags: ["search"]
---

# Search media, playlists, screens and creatives

`GET /v1/search`

## Request

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

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.

## Query parameters

- `q` string, required
- `limit` integer

## Response `200`

Success.

- object
  - `data` object, required
    - `media` object[], required
      - `id` string, required
      - `snippet` string, required: Matched text with `<b>…</b>` around the hit.
    - `playlists` object[], required
      - `id` string, required
      - `snippet` string, required: Matched text with `<b>…</b>` around the hit.
    - `screens` object[], required
      - `id` string, required
      - `snippet` string, required: Matched text with `<b>…</b>` around the hit.
    - `creatives` object[], required
      - `id` string, required
      - `snippet` string, required: Matched text with `<b>…</b>` around the hit.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/7c2741bcdb16?raw)