Skip to main content
Returns a paginated list of processed document entities (docs) within a project. A doc is a structured entity extracted from an ingested file—such as a submittal, RFI, report, or other document type—that Plangrep has classified and normalized. Filter by docType, status, or classification to locate specific document categories.

​
Endpoint

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

​
Path Parameters

​
projectId
string
required
The unique identifier of the project whose docs you want to list.

​
Query Parameters

​
limit
integer
default:"100"
Maximum number of records to return per page. Must be between 1 and 500.
​
cursor
string
Pagination cursor returned as nextCursor from a previous response. Omit to fetch the first page.
​
compact
boolean
When true, artifact URL fields are stripped from each entity, reducing payload size.
​
sheets
string
Comma-separated list of sheet IDs to narrow results.
​
fileId
string
Restrict results to docs extracted from a specific file.
​
fileName
string
Case-insensitive substring match on the parent file name.
​
classification
string
Filter by parent file classification. One of: plans, specifications, documents, addenda, mixed, other.
​
docType
string
Filter by the type of document entity (e.g. submittal, rfi, report, schedule).
​
status
string
Filter by processing status string (e.g. complete, processing, failed).

​
Response

Returns a ProjectDocEntityListResponse object.

​
Pagination Fields

​
total
integer
Total number of doc entities matching the current filters across all pages.
​
limit
integer
The page size limit that was applied to this response.
​
cursor
string
The cursor value used for this page (echoed back from the request).
​
nextCursor
string
Opaque cursor to pass as cursor to retrieve the next page. null when there are no more pages.
​
returnedCount
integer
Number of doc entities actually returned in this response.
​
hasMore
boolean
true if additional pages are available beyond this response.
​
pageInfo
object
Relay-style page info object.

​
Data Fields

​
docs
ProjectDocEntity[]
Array of processed document entities.

​
Example Request

curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/docs?limit=50&docType=submittal&status=complete" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Example Response

{
  "total": 34,
  "limit": 50,
  "cursor": null,
  "nextCursor": null,
  "returnedCount": 34,
  "hasMore": false,
  "pageInfo": {
    "startCursor": "eyJvZmZzZXQiOjB9",
    "endCursor": "eyJvZmZzZXQiOjMzfQ==",
    "hasPreviousPage": false,
    "hasNextPage": false
  },
  "docs": [
    {
      "docId": "doc_001",
      "fileId": "file_003",
      "fileName": "Submittals_Package_1.pdf",
      "docType": "submittal",
      "status": "complete",
      "artifacts": [
        { "type": "extracted_json", "url": "https://..." }
      ]
    }
  ]
}