Building Categories

Retrieve document category breakdowns for buildings. Categories are automatically assigned by the Findable document processing pipeline.

Category Counts

GET/building_owners/{buildingOwnerId}/buildings/{buildingId}/building_category

Get a count of documents per category in a building.

Authentication

x-api-key header

  • buildingOwnerIdstringBuilding owner ID
  • buildingIdstringBuilding ID
  • 200Success
  • 401Missing or invalid API key
  • 404Building not found

All endpoints may also return 429 (rate limit) and 500 (server error). See Common Patterns for details.

  • categoryCountRecord<string, number>Object mapping category names to document counts

Response

{
  "categoryCount": {
    "HVAC": 45,
    "Fire Safety": 32,
    "Electrical": 28,
    "Structural": 21,
    "Plumbing": 15,
    "Energy": 12,
    "Other": 8
  }
}

Documents in Category

GET/building_owners/{buildingOwnerId}/buildings/{buildingId}/building_category/{category}

List all documents in a specific building category. Results are paginated.

Authentication

x-api-key header

  • buildingOwnerIdstringBuilding owner ID
  • buildingIdstringBuilding ID
  • categorystringCategory name (URL-encoded)
  • next_tokenstringPagination token — pass the nextToken value from a previous response
  • 200Success
  • 401Missing or invalid API key
  • 404Building or category not found

All endpoints may also return 429 (rate limit) and 500 (server error). See Common Patterns for details.

  • documentsDocument[]Array of document objects in the category
  • documents[].idstringUnique identifier
  • documents[].filenamestringDocument filename
  • documents[].titlestringDocument title
  • documents[].originalPathstringOriginal file path
  • documents[].buildingCategorystringBuilding category
  • documents[].sizenumberFile size in bytes
  • documents[].createdAtstringISO 8601 creation timestamp
  • documents[].updatedAtstringISO 8601 last update timestamp
  • nextTokenstring | nullToken for the next page, null if this is the last page

Response

{
  "documents": [
    {
      "id": "doc-001",
      "filename": "HVAC-System-Specifications.pdf",
      "title": "HVAC System Specifications",
      "originalPath": "/specs/hvac/",
      "buildingCategory": "HVAC",
      "size": 2400000,
      "createdAt": "2024-02-10T10:00:00Z",
      "updatedAt": "2024-02-10T10:00:00Z"
    }
  ],
  "nextToken": null
}