Skip to navigation
PlatformBrand Kits

API · BrandKit · Get brand kit

View as Markdown

Retrieve a brand kit by ID.

Default response is {id, title} only. Use ?expand=extra to include the full brand envelope (brand, social_links, style). Use ?expand=website for the resolved company website URL. Combine with ?expand=extra,website. Sparse fieldsets via ?fields= and ?omit= are honored on the top-level keys.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

brand_idstringRequiredformat: "uuid"
Brand kit UUID

Query parameters

expandstringOptional

Comma-separated expansions (e.g. extra, website, extra,website).

fieldsstringOptional

Comma-separated top-level keys to include (sparse fieldset).

omitstringOptional

Comma-separated top-level keys to exclude.

Response

Brand kit. Top-level keys present depend on expand/fields.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error