Retrieves a single extracted file entity by its ID. The response includes full metadata—classification, processing status, page count—and any artifact URLs generated during extraction. Pass compact=true to omit artifact URLs when you only need metadata.
Endpoint GET https://plangrep.com/api/open/v1/projects/{projectId}/files/{fileId}
Path Parameters The unique identifier of the project that owns the file.
The unique identifier of the file to retrieve.
Query Parameters When true, artifact URL fields are stripped from the response. Useful when you only need metadata.
Comma-separated list of sheet IDs. Restricts the artifact or related data returned to those sheets.
Optional filter — case-insensitive substring match on the file name. Typically used for consistency with list endpoints when sharing query logic.
Optional filter by file classification. One of: plans, specifications, documents, addenda, mixed, other.
Optional filter by processing status string.
Response Returns an object containing the matching file entity.
The requested file entity. 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/file_001" \ -H "Authorization: Bearer YOUR_API_TOKEN"
Example Response { "file" : { "fileId" : "file_001" , "fileName" : "Architectural_Plans_SetA.pdf" , "classification" : "plans" , "status" : "complete" , "pageCount" : 48 , "artifacts" : [ { "type" : "thumbnail" , "url" : "https://..." }, { "type" : "extracted_json" , "url" : "https://..." } ] } }
