Skip to main content
Fetch the current state of a single API project by its ID. This is the primary endpoint for polling a project after creation — call it repeatedly until status transitions to ready before submitting jobs.

​
Authentication

Include your API key as Authorization: Bearer YOUR_API_KEY in the request headers.

​
Endpoint

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

​
Path Parameters

​
projectId
string
required
The unique identifier of the project to retrieve. Returned as project.id from Create Project or List Projects.

​
Example Request

curl --request GET \
  --url https://plangrep.com/api/open/v1/projects/proj_01hx9z4kqr8e7m3p5n6w2v0abc \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

​
Response Fields

​
project
Project
required
The current state of the requested project.

​
Example Response

{
  "project": {
    "id": "proj_01hx9z4kqr8e7m3p5n6w2v0abc",
    "name": "Downtown Office Tower",
    "projectKind": "open_api",
    "status": "ready",
    "runtime": {
      "status": "running",
      "upgradeStatus": "none"
    },
    "createdAt": "2024-11-01T14:22:10.000Z",
    "updatedAt": "2024-11-01T14:24:05.000Z"
  }
}
When polling after project creation, use an interval of 10 seconds and a maximum wait of 5 minutes. Once status is "ready" you can immediately proceed to create jobs — no additional delay is needed.