---
title: "Get a brand"
method: GET
path: "/v1/brands/{slug}"
tags: ["Brands"]
---

# Get a brand

`GET /v1/brands/{slug}`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/brands/{slug}`
- Auth: API key in header `x-api-key`

Returns one brand by its slug.

## Path parameters

- `slug` string, required

## Response `200`

Brand

- Brand
  - `id` string, required
  - `slug` string, required: The brand's handle, unique in the organization; `samva:brand/<slug>` names it.
  - `name` string, required
  - `isDefault` boolean, required: Whether bare `samva:brand` and domains without a brand resolve to this brand.
  - `css` string, required: Brand theme CSS: `@theme` variables, one dark-mode `@theme` of colors, and `@font-face` rules with https WOFF2 sources.
  - `assets` BrandAssets, required
    - `logoUrl` string, nullable
    - `logoDarkUrl` string, nullable
    - `iconUrl` string, nullable
  - `footer` BrandFooter, required
    - `companyName` string, nullable
    - `address` BrandAddress
      - `street1` string, required
      - `street2` string, nullable
      - `city` string, required
      - `region` string, required
      - `postalCode` string, required
      - `country` string, required
    - `socialLinks` BrandSocialLink[], nullable
      - `label` string, required
      - `url` string, required
  - `digest` string, required: SHA-256 of the brand's css, assets and footer. A publication built against a different digest predates the brand's current content.
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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