> ## 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.

# List workspaces

> Requires workspaces:read.



## OpenAPI

````yaml /openapi.json get /v1/workspaces
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/workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces
      description: Requires workspaces:read.
      operationId: listWorkspaces
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of accessible workspaces.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspacePage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Number of records to return.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Cursor:
      name: cursor
      in: query
      description: Opaque next_cursor value from the previous page.
      schema:
        type: string
  schemas:
    WorkspacePage:
      type: object
      required:
        - items
        - page
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Workspace'
        page:
          $ref: '#/components/schemas/PageInfo'
    Workspace:
      type: object
      required:
        - id
        - public_id
        - name
        - created_at
        - updated_at
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        public_id:
          type: string
        name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PageInfo:
      type: object
      required:
        - has_more
        - next_cursor
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
    Error:
      type: object
      required:
        - type
        - code
        - message
        - status
        - request_id
      properties:
        type:
          type: string
        code:
          type: string
        message:
          type: string
        status:
          type: integer
        request_id:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      examples:
        - 507f1f77bcf86cd799439011
    ErrorDetail:
      type: object
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: The key exceeded 100 requests in one minute.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        A scoped key with the of_live_ prefix, generated from Profile > API
        keys.

````