Skip to main content

​
Overview

OpenAPI Specification

View the live OptaReach OpenAPI document

​
Authentication

The API reference is generated from the OptaReach OpenAPI definition and currently documents 76 operations across the platform surface, including accounts, prospect lists, campaigns, inbox, tracked searches, AI rooms, workspaces, analytics, billing, profile, notifications, and knowledge bases. Current auth schemes exposed in the specification: 
"securitySchemes": {
  "cookieAuth": {
    "type": "apiKey",
    "in": "cookie",
    "name": "token"
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "x-api-key"
  }
}
Use the Endpoints group in the left navigation to browse the full OptaReach API surface generated from the synced specification.