Skip to main content
Returns a paginated list of extracted drawing regions that belong to a specific sheet. Use this endpoint when you already know the target sheetId and want sheet-scoped region results without passing a sheet allowlist query parameter.

​
Endpoint

GET https://plangrep.com/api/open/v1/projects/{projectId}/sheets/{sheetId}/regions

​
Path Parameters

​
projectId
string
required
The unique identifier of the project whose sheet regions you want to list.
​
sheetId
string
required
The unique identifier of the sheet whose regions 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.
​
fileId
string
Restrict results to regions belonging to 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.
​
pageNumber
integer
Filter to regions on this specific 1-based page number. Minimum: 1.
​
regionKind
string
Filter by the detected region kind (for example detail, keynotes, schedule, title_block).
​
regionFamily
string
Filter by region family.
​
placedViewKind
string
Filter by placed-view kind.
​
tableKind
string
Filter by table kind.
​
partRole
string
Filter by source part role.

​
Response

Returns a ProjectRegionEntityListResponse object.
​
total
integer
Total number of regions matching the current filters across all pages.
​
limit
integer
The page size limit applied to this response.
​
cursor
string
The cursor value used for this page.
​
nextCursor
string
Opaque cursor to pass as cursor to retrieve the next page. null when there are no more pages.
​
returnedCount
integer
Number of region entities returned in this response.
​
hasMore
boolean
true if additional pages are available beyond this response.
​
regions
ProjectRegionEntity[]
Array of extracted drawing region entities. Region fields match List Regions.

​
Example Request

curl -X GET "https://plangrep.com/api/open/v1/projects/proj_abc123/sheets/sheet_007/regions?limit=50&regionKind=detail" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Example Response

{
  "total": 12,
  "limit": 50,
  "cursor": null,
  "nextCursor": null,
  "returnedCount": 12,
  "hasMore": false,
  "pageInfo": {
    "startCursor": "eyJvZmZzZXQiOjB9",
    "endCursor": "eyJvZmZzZXQiOjExfQ==",
    "hasPreviousPage": false,
    "hasNextPage": false
  },
  "regions": [
    {
      "regionId": "region_001",
      "fileId": "file_001",
      "sheetId": "sheet_007",
      "fileName": "Architectural_Plans_SetA.pdf",
      "pageNumber": 12,
      "sheetNumber": "A5.01",
      "label": "DETAIL 3/A5.01",
      "text": "CONT. BEAD OF SEALANT AT ALL EDGES. SEE SPEC 07900.",
      "displayBox": { "left": 0.52, "top": 0.31, "right": 0.74, "bottom": 0.58 },
      "titleDisplayBox": { "left": 0.52, "top": 0.58, "right": 0.74, "bottom": 0.62 },
      "artifacts": [
        { "type": "region_crop", "url": "https://...", "readWith": "plangrep_show_artifact_image" },
        { "type": "region_text", "url": "https://...", "readWith": "plangrep_show_artifact_file" }
      ]
    }
  ]
}

​
Error Responses

StatusDescription
400Invalid pagination or filter value.
401Missing or invalid Bearer token.
404Project or sheet not found.