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

# Get the operating map

> Get the workspace map of processes, stages, handoffs, and supporting evidence.



## OpenAPI

````yaml /openapi/v1.yaml get /operating-map
openapi: 3.1.0
info:
  title: OrgX REST API v1
  version: '1'
  description: >-
    Build accountable work into your product with OrgX REST API v1.


    Create work with one field, attach evidence when it is complete, and keep
    the receipt. Every authenticated request is scoped to the workspace resolved
    from your credential.


    Start with `POST /work`. Human guide:
    https://docs.useorgx.com/docs/api/quickstart
  contact:
    name: OrgX Support
    url: https://useorgx.com/support
    email: support@useorgx.com
  license:
    name: Proprietary
    url: https://useorgx.com/terms
servers:
  - url: https://useorgx.com/api/v1
    description: Production
security: []
tags:
  - name: Work
    description: Create accountable work and complete it with evidence
  - name: Initiatives
    description: Organize related work around an outcome
  - name: Operating processes
    description: Evidence-backed company workflow/process lifecycle
  - name: Operating map
    description: Derived, rebuildable Operating Map projection over the process ledger
  - name: Discovery runs
    description: Wizard and deep-search workflow discovery over connected company sources
  - name: Handoffs
    description: Ledger-backed stage handoffs between operating-process stages
  - name: Events
    description: Replayable, workspace-scoped accepted ledger events
  - name: Projections
    description: Workspace-scoped, rebuildable read projections over OrgX sources
  - name: Episodes
    description: Mission-compatible Episode read adapters
  - name: Receipt validation
    description: Account-free Agent Work Receipt schema discovery and conformance
  - name: Receipt import
    description: Authenticated, workspace-scoped import into the hosted receipt ledger
  - name: Workload diagnosis
    description: >-
      Account-free evaluation of time, agents, systems, authority, and
      accountability boundaries
  - name: Content Studio
    description: >-
      Estimate, showcase, checkout, and payment event operations for Content
      Studio
  - name: Decisions
    description: Raise decisions for human ruling and read their state
  - name: Artifacts
    description: Register produced work against the entity it belongs to
  - name: Launches
    description: Preview and run an initiative launch through its spend gates
  - name: Runs
    description: Control agent runs with pause, resume, cancel, and rollback
  - name: Lifecycle
    description: Pause, resume, retry, or cancel work hierarchy nodes and runs
  - name: Deduplication
    description: Claim durable event fingerprints so duplicate triggers fire once
  - name: Credential
    description: >-
      Resolve the calling credential, the workspaces it reaches, and what it may
      do
  - name: API discovery
    description: Account-free error codes, request schemas, and closed vocabularies for v1
externalDocs:
  description: Human-readable OrgX REST API v1 reference
  url: https://docs.useorgx.com/docs/api/public-api
paths:
  /operating-map:
    get:
      tags:
        - Operating map
      summary: Get the operating map
      description: >-
        Get the workspace map of processes, stages, handoffs, and supporting
        evidence.
      operationId: getOperatingMap
      parameters:
        - name: workspace_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          description: Maximum process aggregates to replay for this projection.
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
      responses:
        '200':
          description: Derived Operating Map projection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatingMapResponse'
              example:
                data: {}
                meta: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
        - cookieAuth: []
components:
  schemas:
    OperatingMapResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
          description: The current operating map for the workspace.
          additionalProperties: true
        meta:
          allOf:
            - $ref: '#/components/schemas/ContractMeta'
            - type: object
              required:
                - projectionStatus
                - generatedAt
                - sourceCursor
                - sourceCursorStatus
                - truncated
                - truncation
                - freshness
              properties:
                projectionStatus:
                  type: string
                  enum:
                    - derived_from_ledger
                generatedAt:
                  type: string
                  format: date-time
                sourceCursor:
                  type: string
                sourceCursorStatus:
                  type: string
                  enum:
                    - ledger_replay
                truncated:
                  type: boolean
                  description: True when the projection is partial.
                truncation:
                  type: object
                  additionalProperties: false
                  required:
                    - processes
                    - processLimit
                    - discoverySessions
                    - discoverySessionLimit
                  properties:
                    processes:
                      type: boolean
                    processLimit:
                      type: integer
                    discoverySessions:
                      type: boolean
                    discoverySessionLimit:
                      type: integer
                freshness:
                  type: object
                  additionalProperties: true
                  required:
                    - generatedAt
                    - freshnessWatermark
                  properties:
                    generatedAt:
                      type: string
                      format: date-time
                    freshnessWatermark:
                      type: string
                    sourceHealthSummary:
                      type: object
                      nullable: true
                      additionalProperties: true
    ContractMeta:
      type: object
      additionalProperties: false
      required:
        - apiVersion
        - workspaceId
      properties:
        apiVersion:
          type: string
          const: '1'
        workspaceId:
          type: string
          format: uuid
        count:
          type: integer
          minimum: 0
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
            requestId:
              type: string
            timestamp:
              type: string
              format: date-time
            docsUrl:
              type: string
              format: uri
            retryAfter:
              type: integer
              description: Seconds until rate limit resets
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource is unavailable to the caller
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Ledger or workspace authorization is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'OrgX API key, sent as `Authorization: Bearer oxk_...`'
    cookieAuth:
      type: apiKey
      in: cookie
      name: __session
      description: Session cookie from web authentication

````