Skip to main content
Retrieves a single extracted sheet by its ID. The response includes the sheet’s number, name, display name, parent file reference, page position, and any artifacts generated during extraction (e.g. sheet thumbnail, vector crop). Pass compact=true to omit artifact URLs when you only need metadata.

​
Endpoint

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

​
Path Parameters

​
projectId
string
required
The unique identifier of the project that owns the sheet.
​
sheetId
string
required
The unique identifier of the sheet to retrieve.

​
Query Parameters

​
compact
boolean
When true, artifact URL fields are stripped from the response.
​
sheets
string
Comma-separated list of sheet IDs. Can be used to validate that this sheet is within an expected set.
​
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.
​
status
string
Optional filter by parent file processing status.
​
pageNumber
integer
Optional filter — returns the sheet only if it is located at this 1-based page number. Minimum: 1.
​
sheetNumber
string
Optional filter — returns the sheet only if it matches this sheet number exactly.

​
Response

Returns an object containing the matching sheet entity.
​
sheet
ProjectSheetEntity
The requested sheet entity.

​
Example Request

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

​
Example Response

{
  "sheet": {
    "sheetId": "sheet_001",
    "fileId": "file_001",
    "fileName": "Architectural_Plans_SetA.pdf",
    "pageNumber": 3,
    "sheetNumber": "A1.01",
    "sheetName": "First Floor Plan",
    "sheetDisplayName": "A1.01 – First Floor Plan",
    "artifacts": [
      { "type": "thumbnail", "url": "https://..." },
      { "type": "vector_crop", "url": "https://..." }
    ]
  }
}