Skip to main content
Fetch a dashboard-oriented overview for one project. The overview combines control-plane project state with runtime source-catalog counts when the project runtime is ready. Use this endpoint to decide whether a project can accept uploads, whether source search is available, and whether maintenance actions such as source-index reconciliation or region normalization are useful.

​
Authentication

Include an API key with the jobs:read scope as Authorization: Bearer YOUR_API_KEY.

​
Endpoint

GET https://plangrep.com/api/open/v1/projects/{projectId}/overview

​
Path Parameters

​
projectId
string
required
The unique identifier of the project to inspect.

​
Response Fields

​
project
Project
required
The project record. See Get Project for the Project fields.
​
overview
ProjectOverview
required
Dashboard-oriented source and readiness state for the project.

​
Example Request

curl https://plangrep.com/api/open/v1/projects/proj_abc123/overview \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "project": {
    "id": "proj_abc123",
    "name": "Downtown Tower",
    "projectKind": "open_api",
    "disciplines": ["Architecture", "MEP"],
    "status": "ready",
    "runtime": {
      "status": "ready",
      "upgradeStatus": null
    },
    "createdAt": "2026-07-11T18:00:00.000Z",
    "updatedAt": "2026-07-11T18:02:00.000Z"
  },
  "overview": {
    "status": "ready",
    "statusLabel": "Ready",
    "counts": {
      "files": 2,
      "sheets": 48,
      "regions": 310,
      "vectors": 1200,
      "vectorChunks": 1200,
      "normalizedRegions": 310,
      "specifications": 1,
      "docs": 4
    },
    "disciplines": [
      { "code": "ARCH", "label": "Architectural", "count": 1 },
      { "code": "MECH", "label": "Mechanical", "count": 1 }
    ],
    "latestJob": {
      "id": "open_api_job_abc123",
      "status": "completed",
      "createdAt": "2026-07-11T18:05:00.000Z",
      "updatedAt": "2026-07-11T18:45:00.000Z",
      "completedAt": "2026-07-11T18:45:00.000Z",
      "error": null
    },
    "nextAction": null,
    "capabilities": {
      "canCreateJob": true,
      "canUpload": true,
      "canSearch": true,
      "canVectorize": false,
      "canNormalize": false
    }
  }
}
To include the same overview object on each row from List Projects, call GET /api/open/v1/projects?include=overview.