> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spreadjam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The active brand profile

> Positioning, audience, product, tone, competitors, excluded topics, and pin state.



## OpenAPI

````yaml https://api.spreadjam.com/openapi.json get /v1/brand
openapi: 3.0.0
info:
  title: SpreadJam API
  version: 1.0.0
servers: []
security: []
tags:
  - name: Meta
    description: Identity and metadata about the authenticated key.
  - name: Keywords
    description: Keyword and topic visibility rankings.
  - name: API keys
    description: Manage the workspace's API keys.
  - name: Analytics
    description: AI-visibility analytics for the workspace.
  - name: Brand
    description: The workspace's brand profile and competitors.
  - name: Prompts
    description: Tracked GEO prompts and their cap state.
paths:
  /v1/brand:
    get:
      tags:
        - Brand
      summary: The active brand profile
      description: >-
        Positioning, audience, product, tone, competitors, excluded topics, and
        pin state.
      responses:
        '200':
          description: The active brand profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandProfile'
      security:
        - bearerAuth: []
components:
  schemas:
    BrandProfile:
      type: object
      properties:
        version:
          type: integer
          example: 3
        positioning:
          type: string
          nullable: true
        audience:
          type: string
          nullable: true
        productDescription:
          type: string
          nullable: true
        tone:
          type: string
          nullable: true
        contentStyle:
          type: string
          nullable: true
        competitors:
          type: array
          items:
            type: string
        excludedTopics:
          type: array
          items:
            type: string
        competitorsPinnedAt:
          type: string
          nullable: true
          description: >-
            ISO-8601 UTC when the competitor list was pinned; null when not
            pinned.
      required:
        - version
        - positioning
        - audience
        - productDescription
        - tone
        - contentStyle
        - competitors
        - excludedTopics
        - competitorsPinnedAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A workspace API key issued in Settings → Developer, sent as `Bearer
        sk_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.