Skip to content

kirora.io Get started

Retrieve the workspace brand kitMenu

Retrieve the workspace brand kit

GET/v1/brand-kit

Requires an API key with the templates:read scope. About keys and scopes

Works with integration, agent and partner keys. Also available to embed sessions.

Returns the workspace brand kit. Until it is saved, it holds the defaults: an empty theme, no name, logo, links, header or footer, and updatedAt null. Every email's theme holds only the fields it overrides; the rest come from here. A header block without an image shows the brand kit's logo, and a social block without links shows its social links. A change restyles templates and draft campaigns and journeys at once. Scheduling or sending a campaign, activating a journey and publishing a template freeze the brand kit that email goes out with, so nothing already approved changes. The default header and footer are what gallery and Kiro designs open and close with; emails that place them follow the shared blocks' own changes.

Header parameters

Kirora-Workspacestringoptional

Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

pattern ^[A-Za-z0-9._:-]{1,128}$

Returns

Returns 200 OK with a BrandKit in data. Otherwise returns an error; Errors lists every code and which to retry.

namestring | nullrequired

The sender's name on the unsubscribe and opt-in pages, and the logo's alt text. Null is the workspace name.

1–120 characters

themeEmailThemerequired

The workspace's email look. Every email's theme holds only the fields it overrides; the rest come from here.

14 child attributes

bodyFontFamilystringoptional

Body font stack, such as Inter, sans-serif.

pattern ^[\w\s,'"-]+$ · up to 200 characters

headingFontFamilystringoptional

Heading font stack.

pattern ^[\w\s,'"-]+$ · up to 200 characters

cardBackgroundColorstringoptional

Background of the email card, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

canvasBackgroundColorstringoptional

Background behind the card, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

textColorstringoptional

Default text colour, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

accentColorstringoptional

Brand colour for buttons and highlights, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

linkColorstringoptional

Link colour, as hex.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

headingColorstringoptional

Heading colour, as hex; unset, headings take textColor.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

buttonTextColorstringoptional

Label colour of solid buttons in accentColor, as hex; unset, white or near-black, whichever reads on it.

pattern ^#(?:[0-9a-f]{3}|[0-9a-f]{6})$

baseFontSizestringoptional

Body text size; headings and buttons scale with it. Unset is 16px.

one of 14px, 15px, 16px, 17px, 18px

cardWidthstringoptional

Width of the email card on wide screens.

one of 560px, 600px, 680px

cardBorderRadiusstringoptional

Corner rounding of the email's card.

one of 0px, 6px, 12px, 16px, 24px, 999px

buttonBorderRadiusstringoptional

Button corners; cardBorderRadius rounds the email's card and, when this is unset, buttons.

one of 0px, 6px, 12px, 16px, 24px, 999px

buttonStylestringoptional

Button style.

one of solid, outline

socialLinksobject[]required

The profiles a social block without links of its own shows.

at most 10 items

2 child attributes

labelstringrequired: 1–80 characters
hrefstringrequired: uri · pattern ^[^\s{}]*$ · up to 2,048 characters

defaultHeaderIdstring | nullrequired

The shared block gallery and Kiro designs open with, in place of their logo.

uuid

defaultFooterIdstring | nullrequired

The shared block gallery and Kiro designs close with, in place of their footer. It must hold a footer block.

uuid

logoobject | nullrequired

What a header block without an image of its own shows.

4 child attributes

assetIdstringrequired: uuid
urlstringrequired: The image's address in the workspace library.
altstring | nullrequired: Null is name.
widthstring | nullrequired: pattern ^(?:[89]\d|1\d\d|2[0-3]\d|240)px$

updatedAtstring | nullrequired

Null until the brand kit is saved.

date-time

curl https://api.kirora.io/v1/brand-kit \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/brand-kit', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`Kirora API ${response.status}: ${await response.text()}`);
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/brand-kit",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
response.raise_for_status()
data = response.json()["data"]

package main

import (
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/brand-kit", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	if res.StatusCode >= 300 {
		msg, _ := io.ReadAll(res.Body)
		panic(fmt.Sprintf("Kirora API %d: %s", res.StatusCode, msg))
	}

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

using System.Net.Http.Headers;
using System.Text.Json;

using var http = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.kirora.io/v1/brand-kit");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("KIRORA_API_KEY"));

using var response = await http.SendAsync(request);
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"Kirora API {(int)response.StatusCode}: {await response.Content.ReadAsStringAsync()}");

using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var data = document.RootElement.GetProperty("data");

Response · 200

{
  "data": {
    "name": "Acme Shop",
    "theme": {
      "bodyFontFamily": "Arial, sans-serif",
      "headingFontFamily": "Georgia, serif",
      "cardBackgroundColor": "#ffffff",
      "canvasBackgroundColor": "#f4f1ec",
      "textColor": "#1f2933",
      "accentColor": "#b4461f",
      "linkColor": "#b4461f",
      "cardWidth": "600px",
      "cardBorderRadius": "6px",
      "buttonStyle": "solid",
      "headingColor": "#1f2933",
      "baseFontSize": "16px"
    },
    "logo": {
      "assetId": "0192f3d2-4d5e-7f60-9b72-8d9e0f1a2b3c",
      "url": "https://assets.kirora.io/images/0192f3d2-4d5e-7f60-9b72-8d9e0f1a2b3c.png",
      "alt": null,
      "width": "140px"
    },
    "socialLinks": [
      {
        "label": "Instagram",
        "href": "https://instagram.com/acmeshop"
      },
      {
        "label": "LinkedIn",
        "href": "https://www.linkedin.com/company/acmeshop"
      }
    ],
    "defaultHeaderId": null,
    "defaultFooterId": null,
    "updatedAt": "2026-10-01T09:30:00.000Z"
  }
}