---
title: "GET /core/brands/"
method: GET
path: "/core/brands/"
tags: ["core"]
---

# GET /core/brands/

`GET /core/brands/`

Brand Viewset

## Query parameters

- `brand_uuid` string, uuid
- `branding_default_flow_background` string
- `branding_favicon` string
- `branding_logo` string
- `branding_title` string
- `client_certificates` string[]
- `default` boolean
- `domain` string
- `flow_authentication` string, uuid
- `flow_device_code` string, uuid
- `flow_invalidation` string, uuid
- `flow_lockdown` string, uuid
- `flow_recovery` string, uuid
- `flow_request` string, uuid
- `flow_unenrollment` string, uuid
- `flow_user_settings` string, uuid
- `flow_user_switch` string, uuid
- `ordering` string
- `page` integer
- `page_size` integer
- `search` string
- `web_certificate` string, uuid

## Response `200`

- PaginatedBrandList
  - `pagination` Pagination, required
    - `next` number, required
    - `previous` number, required
    - `count` number, required
    - `current` number, required
    - `total_pages` number, required
    - `start_index` number, required
    - `end_index` number, required
  - `results` Brand[], required
    - `brand_uuid` string, uuid, required
    - `domain` string, required — Domain that activates this brand. Can be a superset, i.e. `a.b` for `aa.b` and `ba.b`
    - `default` boolean
    - `branding_title` string
    - `branding_logo` string
    - `branding_favicon` string
    - `branding_custom_css` string
    - `branding_default_flow_background` string
    - `branding_map_tiles` string — URL template for the vector tile source used by the events map. Supports XYZ templates with {z}, {x} and {y} placeholders, or pmtiles:// archive URLs. When empty, the frontend uses the bundled hexworld basemap. This value is part of the brand information served to unauthenticated clients; do not embed API keys or other credentials in it.
    - `flow_authentication` string, uuid, nullable
    - `flow_user_switch` string, uuid, nullable
    - `flow_invalidation` string, uuid, nullable
    - `flow_recovery` string, uuid, nullable
    - `flow_unenrollment` string, uuid, nullable
    - `flow_user_settings` string, uuid, nullable
    - `flow_device_code` string, uuid, nullable
    - `flow_lockdown` string, uuid, nullable
    - `flow_request` string, uuid, nullable
    - `default_application` string, uuid, nullable — When set, external users will be redirected to this application after authenticating.
    - `web_certificate` string, uuid, nullable — Web Certificate used by the authentik Core webserver.
    - `client_certificates` string[] — Certificates used for client authentication.
    - `attributes` object
  - `autocomplete` Autocomplete, required

## Other responses

- `400`
- `403`

---

[API](https://skmtc.dev/goauthentik/apis/authentik.md) · [All operations](https://skmtc.dev/goauthentik/apis/authentik/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goauthentik/authentik/revisions/4e42e86021d7/schema)