> ## 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. # Read an initiative, optionally with its full tree > Poll half of the scaffold loop. `include=tree` returns workstreams, milestones, and tasks with dependency edges, agent assignments, and estimates, assembled from one batched query set. `include=launches` lists launch summaries when they are available; otherwise it returns an empty list with an explanatory note in `meta.notes`. Initiative ids are UUIDs; resolve names or prefixes through search. ## OpenAPI ````yaml /openapi/v1.yaml get /initiatives/{initiativeId} 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: /initiatives/{initiativeId}: get: tags: - Initiatives summary: Read an initiative, optionally with its full tree description: >- Poll half of the scaffold loop. `include=tree` returns workstreams, milestones, and tasks with dependency edges, agent assignments, and estimates, assembled from one batched query set. `include=launches` lists launch summaries when they are available; otherwise it returns an empty list with an explanatory note in `meta.notes`. Initiative ids are UUIDs; resolve names or prefixes through search. operationId: getInitiative parameters: - name: initiativeId in: path required: true description: Initiative UUID schema: type: string format: uuid - name: workspace_id in: query required: false description: Workspace scope; optional when the API key is workspace-bound schema: type: string format: uuid - name: include in: query required: false description: 'Comma-separated projections: tree, launches' schema: type: string example: tree,launches responses: '200': description: Initiative summary with the requested projections content: application/json: schema: $ref: '#/components/schemas/InitiativeDetailResponse' example: data: initiative: id: 1481c341-089b-4be0-809b-49cb6e4fee48 title: Launch the customer API status: draft summary: Public API surface for customers visibility: private model_tier: balanced execution_policy: mode: gated max_concurrent_agents: 8 aggregateVersion: 1 created_at: '2026-08-19T12:00:00.000Z' updated_at: '2026-08-19T12:00:00.000Z' tree: workstreams: - id: 8f3c7364-de4a-4061-80e0-11911c510d06 name: Engineering goal: Build and validate the API surface status: not_started domain: engineering agent_id: engineering-agent depends_on: [] milestones: - id: 44d38d45-5e2d-4c45-81b4-218019eab39a title: 'Engineering: plan, execute, and validate' status: planned tasks: - id: 7fbb727d-17c4-4bc7-9fc7-60eb15e9314d title: Scope the endpoints status: todo type: research depends_on: [] meta: apiVersion: '1' workspaceId: 09707fa5-aaae-4493-8a23-827111000f89 projectionStatus: live_rows '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '503': $ref: '#/components/responses/ServiceUnavailable' security: - bearerAuth: [] - cookieAuth: [] components: schemas: InitiativeDetailResponse: type: object required: - data - meta properties: data: type: object required: - initiative properties: initiative: type: object required: - id - title - aggregateVersion properties: id: type: string format: uuid title: type: string status: type: - string - 'null' summary: type: - string - 'null' visibility: type: string model_tier: type: - string - 'null' execution_policy: type: - object - 'null' aggregateVersion: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time tree: type: object properties: workstreams: type: array items: type: object launches: type: array items: type: object meta: type: object required: - apiVersion - workspaceId - projectionStatus properties: apiVersion: type: string const: '1' workspaceId: type: string format: uuid projectionStatus: type: string notes: type: object 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: BadRequest: description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/ApiError' 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 ````