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

# Get workspace settings



## OpenAPI

````yaml /openapi.json get /api/v1/workspaces/{workspace}/settings
openapi: 3.0.3
info:
  title: ai-cmo.dev Services API
  version: 1.0.0
servers: []
security: []
tags:
  - name: Meta
    description: Health and the generated API description.
  - name: Auth
    description: Signup, login, sessions and email verification.
  - name: Device authorization
    description: Browser-approved API key provisioning for agents and the MCP server.
  - name: Setup tokens
    description: Single-use tokens that bootstrap a connector or agent.
  - name: MCP
    description: The canonical MCP install prompt.
  - name: Workspaces
    description: Workspace creation, settings, profile and competitors.
  - name: API keys
    description: 'Key lifecycle: create, deliver, acknowledge, rotate, revoke.'
  - name: Connections
    description: Connector status, tests, configuration and credentials.
  - name: Runs
    description: Measurement runs and their jobs.
  - name: Research
    description: The five-stage research pipeline.
  - name: Prompts
    description: The measurement prompt set.
  - name: Recommendations
    description: Recommendation board and guarded lifecycle transitions.
  - name: Reports
    description: Stable report identities and the report catalog.
  - name: Scores & metrics
    description: GEO score, scoreboard, metrics, timeseries and SEO.
  - name: Credits & billing
    description: Micro-USD credits, top-ups and Stripe checkout.
  - name: Team
    description: Members, roles and invitations.
  - name: Chat
    description: The workspace assistant (SSE) and its threads.
  - name: Webhooks
    description: Inbound webhooks.
paths:
  /api/v1/workspaces/{workspace}/settings:
    get:
      tags:
        - Workspaces
      summary: Get workspace settings
      operationId: getWorkspaceSettings
      parameters:
        - name: workspace
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]+$
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceSettings'
      security:
        - cookieAuth: []
        - bearerAuth:
            - settings:read
components:
  schemas:
    WorkspaceSettings:
      type: object
      properties:
        slug:
          type: string
        displayName:
          type: string
        domains:
          type: array
          items:
            type: string
        about:
          type: string
        industry:
          type: string
        email:
          type: string
        brandColors:
          type: object
          properties:
            primary:
              type: string
              pattern: ^#[0-9a-f]{6}$
            secondary: e9e9d7c6-ec9f-45cf-986d-e7df4f576316
            accent: b6926597-231a-41bd-9a5a-429a59768eea
            background: 8aa6ed44-ba60-46aa-ae1a-3bf57d6193ad
            text: fcc9c7d6-cef5-44cf-8675-cb832dad9571
          required:
            - primary
            - secondary
            - accent
            - background
            - text
          additionalProperties: false
        brandMeta:
          type: object
          properties:
            faviconUrl:
              anyOf:
                - type: string
                  enum:
                    - ''
                - type: string
                  format: uri
                  maxLength: 500
            logoUrl: 5d168583-0648-42ac-90bb-5f6851bfe74e
            fontNames:
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 100
              maxItems: 12
          additionalProperties: false
        socials:
          type: object
          properties:
            linkedin:
              anyOf:
                - type: string
                  enum:
                    - ''
                - type: string
                  format: uri
                  maxLength: 500
            x: 820f4599-7172-4b73-a051-af8874328076
            github: d3412652-41eb-4fe3-9850-056673d860a5
            instagram: 75d2c9e0-bd95-4a37-9e98-52fcdb9e0252
            youtube: 0639f1b3-1e0e-4083-8a7d-9d468fb6865a
            tiktok: 5cfd277f-f49f-49da-9975-6c5789d4d81e
          required:
            - linkedin
            - x
            - github
            - instagram
            - youtube
            - tiktok
          additionalProperties: false
        productsServices:
          type: string
        designMd:
          type: string
        icpSummary:
          type: string
        languages:
          type: array
          items:
            type: string
        regions:
          type: array
          items:
            type: string
        activeSetSize:
          type: number
        quotas:
          type: object
          additionalProperties:
            type: number
        icon:
          type: object
          properties:
            ext:
              type: string
            source:
              type: string
              enum:
                - fetched
                - uploaded
            updatedAt:
              type: string
          required:
            - ext
            - source
            - updatedAt
          additionalProperties: false
          nullable: true
      required:
        - slug
        - displayName
        - domains
        - about
        - industry
        - email
        - brandColors
        - brandMeta
        - socials
        - productsServices
        - designMd
        - icpSummary
        - languages
        - regions
        - activeSetSize
        - quotas
        - icon
      additionalProperties: false
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: geo.session
      description: Signed HttpOnly browser session cookie
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: gp_live_<43 base64url characters>
      description: Workspace-bound machine API key

````