Returns a paginated list of all extracted file entities belonging to a project. Each file represents a source document (PDF, drawing set, spec book, etc.) that Plangrep has ingested and processed. Use the filtering parameters to narrow results by name, classification, or processing status.
Endpoint GET https://plangrep.com/api/open/v1/projects/{projectId}/files
Path Parameters The unique identifier of the project whose files 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. Useful when you only need metadata.
Comma-separated list of sheet IDs to restrict results to files that contain those sheets.
Filter to a specific file by its ID.
Case-insensitive substring match against the file name.
Filter by file classification. One of: plans, specifications, documents, addenda, mixed, other.
Filter by processing status string (e.g. complete, processing, failed).
Response Returns a ProjectFileEntityListResponse object.
Total number of files 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 file 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 file entities. Show ProjectFileEntity fields
Unique identifier for this file.
Original name of the uploaded file.
Plangrep classification of the file: plans, specifications, documents, addenda, mixed, or other.
Current processing status of the file.
Number of pages in the file.
Array of artifact objects containing URLs to derived outputs (e.g. thumbnails, extracted JSON). Omitted when compact=true.
Example Request curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/files?limit=25&classification=plans&compact=false" \ -H "Authorization: Bearer YOUR_API_TOKEN"
Example Response { "total" : 42 , "limit" : 25 , "cursor" : null , "nextCursor" : "eyJvZmZzZXQiOjI1fQ==" , "returnedCount" : 25 , "hasMore" : true , "pageInfo" : { "startCursor" : "eyJvZmZzZXQiOjB9" , "endCursor" : "eyJvZmZzZXQiOjI0fQ==" , "hasPreviousPage" : false , "hasNextPage" : true }, "files" : [ { "fileId" : "file_001" , "fileName" : "Architectural_Plans_SetA.pdf" , "classification" : "plans" , "status" : "complete" , "pageCount" : 48 , "artifacts" : [ { "type" : "thumbnail" , "url" : "https://..." } ] } ] }
