---
title: "Get brand configuration"
method: GET
path: "/v1/brands/{brandId}/config"
tags: ["Brands"]
---

# Get brand configuration

`GET /v1/brands/{brandId}/config`

## Request

- Base URL: `https://api.workwing.io`
- URL: `https://api.workwing.io/v1/brands/{brandId}/config`
- Auth: HTTP bearer

## Path parameters

- `brandId` string, uuid, required

## Response `200`

Default Response

- object
  - `data` object, required
    - `branding` object, nullable, required: Null when the brand has no branding settings saved
      - `logo_url` string, nullable, required
      - `favicon_url` string, nullable, required
      - `primary_color` string, nullable, required: Hex colour, #RRGGBB
      - `secondary_color` string, nullable, required: Hex colour, #RRGGBB
      - `accent_color` string, nullable, required: Hex colour, #RRGGBB
      - `custom_domain` string, nullable, required
    - `job_config` object, nullable, required: Null when the brand has no job settings saved
      - `job_number_format` string, nullable, required: Pattern new job numbers follow, e.g. JOB{NUM:5}
      - `job_number_next` integer, nullable, required: The number the next job will take
      - `auto_assign_enabled` boolean, nullable, required
    - `preferences` object, nullable, required: Null when the brand has no preferences saved
      - `timezone` string, nullable, required: IANA time zone name
      - `locale` string, nullable, required
      - `date_format` 'MM/DD/YYYY' | 'DD/MM/YYYY' | 'YYYY-MM-DD' | 'null', nullable, required
      - `time_format` '12h' | '24h' | 'null', nullable, required
      - `first_day_of_week` integer, nullable, required: 0 is Sunday
      - `business_hours_enabled` boolean, nullable, required
      - `business_hours` object, nullable, required: Opening hours keyed by lowercase day name, each `{ start, end, enabled }` with times as HH:MM
  - `meta` object, required
    - `request_id` string, required
    - `timestamp` string, date-time, required

---

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