Skip to main content
GET
Get the component style guide

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

portal
enum<string>
required

interview (career and interview portal) or consumer (coaching portal). Only the interview portal has brands.

Available options:
interview,
consumer
Example:

"interview"

brand_id
string<uuid>

A sub-brand, from the brands document of get_portal_configuration. Leave it out for the main brand, the company's own, whose styles every sub-brand page also offers.

Response

The guide.

portal
string
required
brand
object | null
required
file_rule
string
required

Which files an agent writes and which it leaves alone.

how_to
string[]
required

The steps from a design to a live style.

shared_parts
object[]
required

On every block.

tokens
object[]
required

CSS variables from the style settings; use them with a fallback, var(--jm-color-text, currentColor).

tokens_css
object
required

tokens.css as the draft style settings make it, for the main brand and the sub-brand.

components
object[]
required