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

# Get the OpenAPI document



## OpenAPI

````yaml /openapi.json get /v1/openapi.json
openapi: 3.1.0
info:
  title: Onlyform Public API
  version: '2026-08-01'
  summary: >-
    Programmatic access to Onlyform workspaces, forms, submissions, analytics,
    and webhooks.
  description: >-
    The Onlyform Public API uses stable resource IDs, cursor pagination, scoped
    API keys, and structured errors. API keys are created in the Onlyform
    profile and must be sent in the X-API-Key header. Keys are shown once and
    cannot be recovered.
servers:
  - url: https://api.onlyform.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Inspect the API key owner and effective scopes.
  - name: Workspaces
    description: List and manage accessible workspaces.
  - name: Forms
    description: Create and manage forms and their block definitions.
  - name: Submissions
    description: Read and remove completed form submissions.
  - name: Analytics
    description: Read aggregate form funnel metrics.
  - name: Webhooks
    description: Manage response-completed webhooks and inspect deliveries.
paths:
  /v1/openapi.json:
    get:
      tags:
        - Identity
      summary: Get the OpenAPI document
      operationId: getOpenApiDocument
      responses:
        '200':
          description: The current OpenAPI document.
          content:
            application/json:
              schema:
                type: object
      security: []
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        A scoped key with the of_live_ prefix, generated from Profile > API
        keys.

````