Search documents for a building owner

Search all documents across all buildings for a building owner with filtering, sorting, and aggregations. A key scoped to individual buildings searches only those buildings, and is rejected with 400 if it holds more than 100 of them.

get/v1/building_owners/{buildingOwnerId}/search

Request

Base URL: http://localhost:9000
URL: http://localhost:9000/v1/building_owners/{buildingOwnerId}/search
Auth: API key in header x-api-key

Path parameters

buildingOwnerIdstring required

ID of the building owner

Query parameters

querystring required

Search query

max_resultsinteger required

Maximum results per page, 1-1000. Larger pages cost little more than small ones and are much faster than paging: prefer a single large request over many sequential ones. Use start_index to page beyond it.

start_indexinteger required

Starting index for pagination. Offset paging reaches at most 10000 results; past that an empty page is returned alongside the true numberOfHits.

disciplinestring

Filter by discipline (e.g., "Electrical", "HVAC")

document_type'document' | 'drawing'

Filter by document type

floorstring

Filter by floor level

sort_by'relevance' | 'createdAt' | 'updatedAt' | 'filename' required

Field to sort by. "filename" orders on the stored filename, so the order matches what you see. Sorting is case- and accent-sensitive: uppercase precedes lowercase, and Norwegian æ/ø/å sort after z.

sort_order'asc' | 'desc' required

Sort order (only applies when sort_by is not "relevance")

include_aggregationsboolean required

Include aggregated facet counts in response

fuzziness'auto' | 'on' | 'off' required

Fuzzy-matching mode. "on" always fuzzy-matches (best for prose). "off" matches exactly (best for equipment, system and drawing codes). "auto" (default) keeps fuzzy matching for prose but turns it off when the query looks like an identifier - any token containing a digit, or an all-short query such as "VVS".

Response

Default Response

numberOfHitsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.