Skip to main content
Returns a paginated list of extracted specification sections within a project. Each entity represents a discrete CSI-formatted (or similar) specification section, including its section number, title, page range, and structured facets that break the section into labeled sub-components. Filter by section number or page range to zero in on specific content.

​
Endpoint

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

​
Path Parameters

​
projectId
string
required
The unique identifier of the project whose specification sections 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 specification sections 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.
​
sectionNumber
string
Filter to sections with this exact section number (e.g. 03 30 00, 09 90 00).
​
pageStart
integer
Filter to sections whose content starts at or after this 1-based page number. Minimum: 1.
​
pageEnd
integer
Filter to sections whose content ends at or before this 1-based page number. Minimum: 1.

​
Response

Returns a ProjectSpecificationEntityListResponse object.

​
Pagination Fields

​
total
integer
Total number of specification sections 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 specification 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

​
specifications
ProjectSpecificationEntity[]
Array of extracted specification section entities.

​
Example Request

curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/specifications?limit=20&sectionNumber=03%2030%2000" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Example Response

{
  "total": 85,
  "limit": 20,
  "cursor": null,
  "nextCursor": "eyJvZmZzZXQiOjIwfQ==",
  "returnedCount": 20,
  "hasMore": true,
  "pageInfo": {
    "startCursor": "eyJvZmZzZXQiOjB9",
    "endCursor": "eyJvZmZzZXQiOjE5fQ==",
    "hasPreviousPage": false,
    "hasNextPage": true
  },
  "specifications": [
    {
      "specificationId": "spec_001",
      "fileId": "file_002",
      "fileName": "Project_Specifications.pdf",
      "sectionNumber": "03 30 00",
      "sectionTitle": "Cast-In-Place Concrete",
      "pageStart": 45,
      "pageEnd": 62,
      "facets": [
        {
          "facetId": "facet_001",
          "facetKey": "part_1_general",
          "facetKind": "part",
          "facetLabel": "PART 1 – GENERAL",
          "coverageKind": "full",
          "facetText": "1.01 SUMMARY\nA. Section includes cast-in-place concrete...",
          "pageStart": 45,
          "pageEnd": 48
        }
      ],
      "artifacts": []
    }
  ]
}