Sign in

v1

latestOpenAPI 3.0.12026-07-2318588.1 KB
Brand Kits

List Brand Kits

Brand Kits for AEO operations — provides the brand_kit_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).

post/public_api/brand_kits/list

Request body

workspace_idinteger

ID of the workspace to retrieve brand kits from. If not provided, returns brand kits from all workspaces the user belongs to.

includesstring[]

Include related resources.

Available includes:

  • product_lines: Include product lines for this Brand Kit
  • competitors: Include competitor analysis
  • audiences: Include target audiences for this Brand Kit
  • content_types: Include content types configuration
fieldsstring[]

Select additional fields to return.

Default fields (id, brand_name, workspace_name) are always included.

Optional fields:

  • brand_url: URL of the brand website
  • brand_about: Description/overview of the brand
  • brand_customer: Description of the target customer
  • brand_competitors: Information about brand competitors
  • brand_point_of_view: The brand's unique perspective or stance
  • writing_persona: The persona/voice used in brand writing
  • writing_tone: The tone of voice for brand content
  • writing_cta: Default call-to-action text
  • writing_cta_url: URL for call-to-action links
  • writing_rules: Writing rules and guidelines
  • writing_sample_title: Title of the writing sample
  • writing_sample_outline: Outline of the writing sample
  • writing_sample_body: Body content of the writing sample
  • writing_sample_url: URL reference for the writing sample
  • primary_color: Primary brand color (hex format, e.g., #FF5733)
  • secondary_color: Secondary brand color (hex format)
  • accent_color: Accent brand color (hex format)
  • header_case: Header case style (title_case, sentence_case, or custom)
  • header_case_custom_value: Custom header case rules (when header_case is custom)
  • countries: Array of country codes for brand targeting (e.g., ["US", "GB", "CA"])
  • aeo_enabled: Whether AEO is enabled for the Brand Kit
  • prompts_count: Number of prompts/questions associated with this Brand Kit
  • created_at: When the Brand Kit was created
  • updated_at: When the Brand Kit was last updated
sort'brand_name' | '-brand_name' | 'created_at' | '-created_at' | 'prompts_count' | '-prompts_count'

Sort field. Prefix with - for descending.

Available sort fields:

  • brand_name/-brand_name: Sort alphabetically by brand name
  • created_at/-created_at: Sort by creation date
  • prompts_count/-prompts_count: Sort by number of prompts/questions
pageinteger

Page number

per_pageinteger

Items per page

Response

Successful response