---
title: "List the project's design system (merged with its overrides)"
method: GET
path: "/v1/projectId/{projectId}/design-systems"
tags: ["Design Systems"]
---

# List the project's design system (merged with its overrides)

`GET /v1/projectId/{projectId}/design-systems`

## Request

- Base URL: `https://api.bluefox.email`
- URL: `https://api.bluefox.email/v1/projectId/{projectId}/design-systems`
- Auth: HTTP bearer

Always a single-item list (or empty) - the design system this project is currently using (project.designSystemId), merged with the project's overrides (designSystemParams). Kept as a list for consistency with other resources.

## Path parameters

- `projectId` string, required

## Query parameters

- `limit` integer
- `skip` integer
- `sort` 'name' | 'updatedAt' | 'createdAt'
- `order` 'asc' | 'desc'
- `filter[<field>]` string

## Response `200`

OK

- object
  - `status` integer
  - `result` object
    - `items` DesignSystem[]
      - `_id` string
      - `name` string
      - `variables` object
        - `colors` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `fontStacks` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `images` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `links` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `texts` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
      - `font` object
        - `resources` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `stacks` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
      - `components` object
        - `buttons` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `texts` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `images` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
        - `dividers` DesignSystemEntry[]
          - `name` string: Matches an entry's name is required when calling PATCH .../design-systems/{id} to override or reset it.
          - `value` unknown
          - `main` boolean
          - `description` string
          - `overridden` boolean: True when this project has its own override for this entry, as opposed to inheriting the base design system's value.
    - `count` integer: Total matching items across all pages, not just this page.
    - `next` string, nullable: Full URL (path + query string) of the next page, or null if this is the last page.

## Other responses

- `403`: Missing or invalid API key

---

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