Returns a paginated list of extracted sheet entities within a project. A sheet corresponds to a single page from an ingested file that Plangrep has identified as a distinct drawing or document sheet—complete with a sheet number, display name, and associated artifacts. Filter by sheet number, source file, classification, or page number to narrow results.
Endpoint GET https://plangrep.com/api/open/v1/projects/{projectId}/sheets
Path Parameters The unique identifier of the project whose sheets you want to list.
Query Parameters Maximum number of records to return per page. Must be between 1 and 500 .
Pagination cursor returned as nextCursor from a previous response. Omit to fetch the first page.
When true, artifact URL fields are stripped from each entity, reducing payload size.
Comma-separated list of sheet IDs to include. Acts as an allowlist filter.
Restrict results to sheets that belong to this file.
Case-insensitive substring match on the parent file’s name.
Filter by parent file classification. One of: plans, specifications, documents, addenda, mixed, other.
Filter by processing status of the parent file.
Filter to sheets located at this specific 1-based page number within their source file. Minimum: 1.
Filter to sheets with this exact sheet number (e.g. A1.01, S-200).
Response Returns a ProjectSheetEntityListResponse object.
Total number of sheets matching the current filters across all pages.
The page size limit that was applied to this response.
The cursor value used for this page (echoed back from the request).
Opaque cursor to pass as cursor to retrieve the next page. null when there are no more pages.
Number of sheet entities actually returned in this response.
true if additional pages are available beyond this response.
Relay-style page info object. Cursor pointing to the first record in this page.
Cursor pointing to the last record in this page.
true if records exist before this page.
true if records exist after this page.
Data Fields Array of extracted sheet entities. Show ProjectSheetEntity fields
Unique identifier for this sheet.
ID of the parent file this sheet was extracted from.
1-based page number within the source file.
Extracted sheet number (e.g. A1.01, M-300). May be null if not detected.
Extracted short sheet name or title block title.
Human-readable display name combining sheet number and title (e.g. A1.01 – Floor Plan).
Array of artifact objects containing URLs to derived outputs. Omitted when compact=true.
Example Request curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/sheets?limit=50&classification=plans&sheetNumber=A1.01" \ -H "Authorization: Bearer YOUR_API_TOKEN"
Example Response { "total" : 120 , "limit" : 50 , "cursor" : null , "nextCursor" : "eyJvZmZzZXQiOjUwfQ==" , "returnedCount" : 50 , "hasMore" : true , "pageInfo" : { "startCursor" : "eyJvZmZzZXQiOjB9" , "endCursor" : "eyJvZmZzZXQiOjQ5fQ==" , "hasPreviousPage" : false , "hasNextPage" : true }, "sheets" : [ { "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://..." } ] } ] }
