API Reference

General Introduction

Base Styles is a Brand Management Platform. The Base Styles API allows you to obtain your branding assets and elements programmatically. This helps create a single truth for the branding instead of defining it at multiple places.

To access to this API, make sure that your workspace is on the Business or Agency plan.

General Authentication

Every request to the Base Styles API requires an API key in the header. An API key is tied to a workspace, meaning that you can only obtain all branding elements of the workspace that your API key is generated in.

To obtain an API key for your workspace in Base Styles:

  1. Go to the
    page and navigate to the tab
    .
  2. Click on Create new API key. When the API key is generated, click once on the field to reveal the API key, and again to copy the API key.

Include the API key in your API request by the following key/value to the header

of the request.

General Base URL

The base URL of the API is

Endpoint Colors

Obtain your brand colors using one of the two

endpoints, one for all colors and one for an individual color.

Retrieving one color

GET
/colors/:id

To retrieve one specific color of your brand, you need the identifier of the color.

Retrieving all colors

GET
/colors

To retrieve all colors of your brand, you can use this endpoint.

Endpoint Fonts

Obtain your brand fonts using one of the two

endpoints, one for all fonts and one for an individual font.

Retrieving one font

GET
/fonts/:id

To retrieve one specific font of your brand, you need the identifier of the font.

Retrieving all fonts

GET
/fonts

To retrieve all fonts of your brand, you can use this endpoint.

Endpoint Logos

Obtain your brand logos using one of the two

endpoints, one for all logos and one for an individual logo.

Retrieving one logo

GET
/logos/:id

To retrieve one specific logo of your brand, you need the identifier of the logo.

Retrieving all logos

GET
/logos

To retrieve all logos of your brand, you can use this endpoint.

Endpoint Visuals

Obtain your brand visuals using one of the two

endpoints, one for all visuals and one for an individual visual.

Retrieving one visual

GET
/visuals/:id

To retrieve one specific visual of your brand, you need the identifier of the visual.

Retrieving all visuals

GET
/visuals

To retrieve all visuals of your brand, you can use this endpoint.

Endpoint Headings

Obtain your brand headings using the following

endpoint.

Retrieving all headings

GET
/headings

To retrieve all headings of your brand, you can use this endpoint.