brandKits

API · BrandKit · Get brand kit

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. To read the whole kit, send only expand — leave fields and omit out. brand, social_links and style sit inside extra, not at the top level.

get/api/v2/brandkits/{brand_id}

Request

  • Base URL
    https://api.simplified.com
  • Auth
    API key in header Authorization

Path parameters

brand_idstring uuid required

Brand kit UUID

Query parameters

expandstring

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

fieldsstring

Optional. Comma-separated top-level keys to include (id, title, extra, website). Omit it to get every key expand asked for; brand, style and social_links come from expand=extra.

omitstring

Optional. Comma-separated top-level keys to exclude.

Response

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

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.