Skip to main content
Retrieves a single extracted specification section by its ID. The response includes the full section metadata, all structured facets (each containing up to 50,000 characters of source text), and any artifact URLs generated during processing.

Endpoint

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

Path Parameters

projectId
string
required
The unique identifier of the project that owns the specification section.
specificationId
string
required
The unique identifier of the specification section to retrieve.

Query Parameters

compact
boolean
When true, artifact URL fields are stripped from the response.
sheets
string
Comma-separated list of sheet IDs to narrow context.
fileId
string
Optional filter by parent file ID.
fileName
string
Optional case-insensitive substring match on the parent file name.
classification
string
Optional filter by parent file classification. One of: plans, specifications, documents, addenda, mixed, other.
sectionNumber
string
Optional filter — returns the section only if it matches this section number.
pageStart
integer
Optional filter — returns the section only if it starts at or after this 1-based page number. Minimum: 1.
pageEnd
integer
Optional filter — returns the section only if it ends at or before this 1-based page number. Minimum: 1.

Response

Returns an object containing the matching specification entity.
specification
ProjectSpecificationEntity
The requested specification section entity.

Example Request

curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/specifications/spec_001" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
  "specification": {
    "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 for all structural and architectural elements...",
        "pageStart": 45,
        "pageEnd": 48
      },
      {
        "facetId": "facet_002",
        "facetKey": "part_2_products",
        "facetKind": "part",
        "facetLabel": "PART 2 – PRODUCTS",
        "coverageKind": "full",
        "facetText": "2.01 CONCRETE MATERIALS\nA. Portland Cement: ASTM C150...",
        "pageStart": 49,
        "pageEnd": 55
      }
    ],
    "artifacts": []
  }
}