---
title: "Search Brands"
method: GET
path: "/v1/brands"
tags: ["Brands"]
---

# Search Brands

`GET /v1/brands`

Search brands with optional filtering and pagination. Results are sorted alphabetically by name.

## Query parameters

- `page` integer
- `pageSize` integer
- `id` string
- `name` string
- `nameShort` string
- `domain` string
- `idContains` string
- `nameContains` string
- `nameShortContains` string
- `domainContains` string

## Response `200`

Default Response

- object
  - `meta` object, required
    - `page` integer, required
    - `pageSize` integer, required
    - `total` integer, required
    - `returned` integer, required
  - `brands` object[], required
    - `_id` string, required
    - `name` string
    - `nameShort` string
    - `subname` string
    - `domain` string
    - `colors` object
      - `primary` string
      - `secondary` string
    - `logos` object
      - `favicon` string
      - `loading` string
      - `main` string
    - `createdAt` string, date-time
    - `createdBy` string
    - `allowEmployerRegistration` boolean
    - `providers` string[]
    - `integrations` object
    - `hl7Config` object
      - `url` string
      - `user` string
      - `pass` string
      - `proto` string
      - `port` string
      - `interfaceName` string
    - `brandId` string

## Other responses

- `401` — Default Response
- `403` — Default Response
- `500` — Default Response

---

[API](https://skmtc.net/bluehive-health/apis/bluehive-api.md) · [All operations](https://skmtc.net/bluehive-health/apis/bluehive-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bluehive-health/bluehive-api/revisions/e6e553c2594a/schema)