---
title: "Get the workspace OpenPost Image Editor brand kit"
method: GET
path: "/image-editor/brand-kit"
tags: ["OpenPost Image Editor"]
---

# Get the workspace OpenPost Image Editor brand kit

`GET /image-editor/brand-kit`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/image-editor/brand-kit`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

## Query parameters

- `workspace_id` string, required

## Response `200`

OK

- ImageEditorBrandKitResponse
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `backgrounds` string[], nullable, required
  - `can_edit` boolean, required
  - `colors` ImageEditorBrandColor[], nullable, required
    - `id` string, required
    - `name` string, required
    - `value` string, required
  - `effect_presets` ImageEditorEffectPresetResponse[], nullable, required
    - `effects` ImageEditorLayerEffects, required
      - `blend_mode` 'normal' | 'multiply' | 'screen' | 'overlay' | 'darken' | 'lighten' | 'soft_light', required
      - `drop_shadow` ImageEditorShadowEffect
        - `angle` number, double, required
        - `blur` number, double, required
        - `color` string, required
        - `distance` number, double, required
        - `opacity` number, double, required
      - `inner_shadow` ImageEditorShadowEffect
        - `angle` number, double, required
        - `blur` number, double, required
        - `color` string, required
        - `distance` number, double, required
        - `opacity` number, double, required
      - `stroke` ImageEditorStrokeEffect
        - `color` string, required
        - `opacity` number, double, required
        - `position` 'inside' | 'center' | 'outside', required
        - `width` number, double, required
    - `id` string, required
    - `name` string, required
  - `exists` boolean, required
  - `fonts` ImageEditorBrandFont[], nullable, required
    - `css_family` string
    - `family` string, required
    - `id` string
    - `license_acknowledged` boolean
    - `license_acknowledged_at` string
    - `license_acknowledged_by` string
    - `media_id` string, required
    - `style` 'normal' | 'italic', required
    - `weight` integer, required
  - `id` string
  - `name` string, required
  - `revision` integer, required
  - `text_styles` ImageEditorBrandTextStyle[], nullable, required
    - `color` string, required
    - `font_asset_id` string
    - `font_family` string, required
    - `font_size` number, double, required
    - `font_style` string, required
    - `font_weight` integer, required
    - `id` string, required
    - `letter_spacing` number, double, required
    - `line_height` number, double, required
    - `name` string, required
  - `updated_at` string
  - `workspace_id` string, required

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

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