Skip to main content
Retrieves a single processed document entity by its ID. The response includes the doc’s type, current processing status, parent file reference, and any artifact URLs generated during processing. Pass compact=true to omit artifact URLs when you only need metadata.

​
Endpoint

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

​
Path Parameters

​
projectId
string
required
The unique identifier of the project that owns the doc.
​
docId
string
required
The unique identifier of the doc entity to retrieve.

​
Query Parameters

​
compact
boolean
When true, artifact URL fields are stripped from the response.
​
sheets
string
Comma-separated list of sheet IDs to narrow context.
​
fileId
string
Optional filter by parent file ID.
​
fileName
string
Optional case-insensitive substring match on the parent file name.
​
classification
string
Optional filter by parent file classification. One of: plans, specifications, documents, addenda, mixed, other.
​
docType
string
Optional filter — returns the doc only if it matches this document type.
​
status
string
Optional filter — returns the doc only if it matches this processing status.

​
Response

Returns an object containing the matching doc entity.
​
doc
ProjectDocEntity
The requested document entity.

​
Example Request

curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/docs/doc_001" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Example Response

{
  "doc": {
    "docId": "doc_001",
    "fileId": "file_003",
    "fileName": "Submittals_Package_1.pdf",
    "docType": "submittal",
    "status": "complete",
    "artifacts": [
      { "type": "extracted_json", "url": "https://..." },
      { "type": "thumbnail", "url": "https://..." }
    ]
  }
}