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

# OpenAPI document



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/openapi.json
openapi: 3.1.0
info:
  title: Optareach Public API
  version: 1.0.0
  description: >-
    Platform-first API surface for accounts, prospects, campaigns, inbox,
    tracked searches, AI rooms, jobs, workspaces, analytics, billing, profile,
    and knowledge bases.
servers:
  - url: /
    description: Current environment
security: []
tags:
  - name: Meta
    description: API metadata and discovery
  - name: Platforms
    description: Platform registry and capabilities
  - name: Accounts
    description: Connected sender accounts
  - name: Prospects
    description: Prospect lists and leads
  - name: Campaigns
    description: Campaign lifecycle and performance
  - name: Inbox
    description: Conversations and messages
  - name: TrackedSearches
    description: Mentions and tracked search streams
  - name: AI
    description: AI chat rooms and enrichment
  - name: Jobs
    description: Background jobs
  - name: Workspaces
    description: Workspace management
  - name: KnowledgeBases
    description: Knowledge base management
  - name: Analytics
    description: Global dashboard metrics
  - name: Billing
    description: Subscriptions and credits
  - name: Profile
    description: Current user profile
  - name: Tags
    description: Conversation tags
  - name: Notifications
    description: Notification feed
paths:
  /api/v1/openapi.json:
    get:
      tags:
        - Meta
      summary: OpenAPI document
      responses:
        '200':
          description: OpenAPI spec JSON
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                openapi: 3.1.0
                info:
                  title: Optareach Public API
                  version: 1.0.0
                paths:
                  /api/v1:
                    get:
                      summary: API root metadata

````