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.

GET /initiatives/{initiativeId}

Read an initiative, optionally with its full tree

cURL

curl --request GET \
  --url https://useorgx.com/api/v1/initiatives/{initiativeId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
  }
}

Authorizations

bearerAuthcookieAuth

Authorization · string · header · required

OrgX API key, sent as Authorization: Bearer oxk_...

Path Parameters

initiativeId · string<uuid> · required

Initiative UUID

Query Parameters

workspace_id · string<uuid>

Workspace scope; optional when the API key is workspace-bound

include · string

Comma-separated projections: tree, launches

Example:

"tree,launches"

Response

200

application/json

Initiative summary with the requested projections

data · object · required

Show child attributes

meta · object · required

Show child attributes