Document Platform
Search documents with pagination metadata
Search for documents with document-level FGA filtering. Returns hasMore for infinite scroll.
get/customers/{customerId}/v2/search
Request
- Base URL: http://localhost:9000
- URL: http://localhost:9000/customers/{customerId}/v2/search
- Auth: API key in header x-api-key
Path parameters
customerIdstring uuid required
Query parameters
buildingIdstring uuid
buildingIdsstring
Comma-separated list of building UUIDs
projectIdstring uuid
Project UUID for project-scoped document access
propertyIdsstring
Comma-separated list of portfolio UUIDs
querystring
numberOfHitsinteger required
Number of hits to return
offsetinteger required
Offset to start from
disciplinestring
documentTypestring
floorstring
sortFieldstring
disableFuzzinessboolean
useAiFilenamesboolean
aggregationFieldsstring
Comma-separated list of aggregation fields
disableFilenameFallback'true' | 'false'
Skip the filename fallback on a search with no hits (typeahead)
Changes
No recorded changes to this operation across all 1 revision of this API.