API docs by Redocly

search API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the search stack.

SearchService

Generate a search API key

Generates an authorized search API key for the given accountId. Returns the key string.

Request Body schema: application/json
required
accountId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "accountId": "string"
}

Response samples

Content type
application/json
{
  • "key": "string"
}

Generate an unauthorized search API key

Generates a search API key without account authorization. The request has no parameters. Returns the key string.

Request Body schema: application/json
required
object (searchGenerateUnauthorizedApiKeyRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "key": "string"
}

Global free-text search across entity types

Returns up to 7 best Atlas Search matches for accountId across contacts, properties, buildings, objects, tenancies and condominiums. No filters. ACL via allowedAccountIds. Atlas-only (not Algolia).

Request Body schema: application/json
required
accountId
required
string <int64> (must match auth; ACL filter)
language
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
query
required
string (free-text; empty => empty hits)

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "hits": [
    ]
}

List buildings from the search read model

Paginated, filterable and searchable building list replacing Algolia building index queries. ACL is enforced server-side: only buildings where allowedAccountIds contains accountId (from auth) are returned. Free-text query searches numericId, name, address.street, address.streetNumber, address.streetAddition, address.zip and address.city. Default sort when no sort* field is set: buildingStrategy.reviewAtSortValue ASC, then owner.name ASC, then name ASC, then address.city ASC, then address.zip ASC, then address.street ASC, then address.streetNumber ASC, then objectCount ASC. When a sort* field is set, it is the primary sort; remaining defaults are applied as tie breakers. At most one primary sort* should be set. Searchable facet typeahead (cities, zips, craftsmen/janitors/serviceProviders/owner/network-partner names, objectCounts) is done client-side on the returned facet buckets.

Request Body schema: application/json
required
accountId
required
string <int64>

Must match auth. Used for the allowedAccountIds ACL filter.

buildingStrategyTypes
required
Array of strings (facets without free-text typeahead)
Items Enum: "BUILDING_STRATEGY_TYPE_UNDEFINED" "BUILDING_STRATEGY_TYPE_NO_RENOVATION" "BUILDING_STRATEGY_TYPE_MAINTAIN" "BUILDING_STRATEGY_TYPE_REPAIR" "BUILDING_STRATEGY_TYPE_REPLACEMENT" "BUILDING_STRATEGY_TYPE_SALE"

Maps to buildingStrategy.type. Not-searchable facet. Empty = no filter.

cities
required
Array of strings (searchable facets (typeahead client-side))

Maps to address.city. Searchable facet; typeahead is client-side. Empty = no filter.

craftsmenNames
required
Array of strings

Maps to craftsmen.name. Searchable facet; typeahead is client-side. Empty = no filter.

includeFacets
required
boolean

When true, response includes facet buckets (cities, zips, craftsmen/janitors/serviceProviders/owner/network-partner names, objectCounts, buildingStrategyTypes, propertyTypes). filterOnly networkPartnerCombinedIds are not returned.

itemsPerPage
required
integer <int32>

Only used when page is set.

janitorsNames
required
Array of strings

Maps to janitors.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerAccountingNames
required
Array of strings

Maps to networkPartnerAccounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerAssetNames
required
Array of strings

Maps to networkPartnerAsset.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerCombinedIds
required
Array of strings (filterOnly)

Maps to networkPartners.combinedId. filterOnly facet. Empty = no filter.

objectCounts
required
Array of integers <int32> [ items <int32 > ]

Maps to objectCount. Searchable facet; typeahead is client-side. Empty = no filter.

ownerNames
required
Array of strings

Maps to owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

page
required
integer <int32>

1-based. Leave out or set to 0 to disable pagination.

propertyTypes
required
Array of strings (propertyv2PropertyType)
Items Enum: "PROPERTY_TYPE_UNDEFINED" "PROPERTY_TYPE_RENTAL" "PROPERTY_TYPE_CONDOMINIUM_OWNERSHIP" "PROPERTY_TYPE_COOPERATIVE"

Maps to propertyType. Not-searchable facet. Empty = no filter.

query
required
string

Free-text search over numericId, name, address.street, address.streetNumber, address.streetAddition, address.zip and address.city. Empty = filter/sort only.

serviceProvidersNames
required
Array of strings

Maps to serviceProviders.name. Searchable facet; typeahead is client-side. Empty = no filter.

sortCity
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortObjectCount
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortOwnerName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortReviewAt
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortStreet
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortStreetNumber
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortZip
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
zips
required
Array of strings

Maps to address.zip. Searchable facet; typeahead is client-side. Empty = no filter.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "buildingStrategyTypes": [
    ],
  • "cities": [
    ],
  • "craftsmenNames": [
    ],
  • "includeFacets": true,
  • "itemsPerPage": 0,
  • "janitorsNames": [
    ],
  • "networkPartnerAccountingNames": [
    ],
  • "networkPartnerAssetNames": [
    ],
  • "networkPartnerCombinedIds": [
    ],
  • "objectCounts": [
    ],
  • "ownerNames": [
    ],
  • "page": 0,
  • "propertyTypes": [
    ],
  • "query": "string",
  • "serviceProvidersNames": [
    ],
  • "sortCity": "UNDEFINED_SORT_ORDER",
  • "sortName": "UNDEFINED_SORT_ORDER",
  • "sortObjectCount": "UNDEFINED_SORT_ORDER",
  • "sortOwnerName": "UNDEFINED_SORT_ORDER",
  • "sortReviewAt": "UNDEFINED_SORT_ORDER",
  • "sortStreet": "UNDEFINED_SORT_ORDER",
  • "sortStreetNumber": "UNDEFINED_SORT_ORDER",
  • "sortZip": "UNDEFINED_SORT_ORDER",
  • "zips": [
    ]
}

Response samples

Content type
application/json
{
  • "facets": {
    },
  • "hits": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

List condominiums from the search read model

Paginated, filterable and searchable condominium list replacing Algolia condominium index queries. ACL is enforced server-side: only condominiums where allowedAccountIds contains accountId (from auth) are returned. Free-text query searches condominiumOwners.name, billingContact.name, tenants.name, roommates.name, numericId, obj.numericId, obj.address.street/streetNumber/mailbox/subUnit/streetAddition/zip/city. Default sort when no sort* field is set: numericId ASC. When sortNumericId is set, it is the primary sort. Searchable facet typeahead is done client-side on the returned facet buckets.

Request Body schema: application/json
required
accountId
required
string <int64>

Must match auth. Used for the allowedAccountIds ACL filter.

assigneeAccountingNames
required
Array of strings

Maps to obj.assignees.accounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAdministrationNames
required
Array of strings

Maps to obj.assignees.administration.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAssetNames
required
Array of strings

Maps to obj.assignees.asset.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeMarketingNames
required
Array of strings

Maps to obj.assignees.marketing.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeOwnerNames
required
Array of strings

Maps to obj.assignees.owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

categories
required
Array of strings (facets without free-text typeahead)
Items Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"

Maps to obj.category. Not-searchable facet. Empty = no filter.

closed
required
boolean (filterOnly)

Maps to closed. filterOnly facet. Unset = no filter.

floors
required
Array of numbers <double> [ items <double > ]

Maps to obj.floor (decimalFloor). Not-searchable facet. Empty = no filter.

includeFacets
required
boolean

When true, response includes facet buckets. filterOnly facets are not returned.

itemsPerPage
required
integer <int32>

Only used when page is set.

networkPartnerCombinedIds
required
Array of strings

Maps to obj.networkPartners.combinedId. filterOnly facet. Empty = no filter.

ownerNames
required
Array of strings

Maps to owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

page
required
integer <int32>

1-based. Leave out or set to 0 to disable pagination.

preferredCommunicationChannels
required
Array of strings (v2PreferredCommunicationChannel)
Items Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"

Maps to preferredCommunicationChannel. Not-searchable facet. Empty = no filter.

query
required
string

Free-text search over condominiumOwners.name, billingContact.name, tenants.name, roommates.name, numericId, obj.numericId, obj.address.street/streetNumber/mailbox/subUnit/streetAddition/zip/city. Empty = filter/sort only.

rooms
required
Array of numbers <double> [ items <double > ]

Maps to obj.rooms. Searchable facet; typeahead is client-side. Empty = no filter.

sortNumericId
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
statuses
required
Array of strings

Maps to status (denormalized label). Not-searchable facet. Empty = no filter.

tags
required
Array of strings

Maps to obj.tags. Searchable facet; typeahead is client-side. Empty = no filter.

zips
required
Array of strings (searchable facets (typeahead client-side))

Maps to obj.address.zip. Searchable facet; typeahead is client-side. Empty = no filter.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "assigneeAccountingNames": [
    ],
  • "assigneeAdministrationNames": [
    ],
  • "assigneeAssetNames": [
    ],
  • "assigneeMarketingNames": [
    ],
  • "assigneeOwnerNames": [
    ],
  • "categories": [
    ],
  • "closed": true,
  • "floors": [
    ],
  • "includeFacets": true,
  • "itemsPerPage": 0,
  • "networkPartnerCombinedIds": [
    ],
  • "ownerNames": [
    ],
  • "page": 0,
  • "preferredCommunicationChannels": [
    ],
  • "query": "string",
  • "rooms": [
    ],
  • "sortNumericId": "UNDEFINED_SORT_ORDER",
  • "statuses": [
    ],
  • "tags": [
    ],
  • "zips": [
    ]
}

Response samples

Content type
application/json
{
  • "facets": {
    },
  • "hits": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

List contacts from the search read model

Paginated, filterable and searchable contact list replacing Algolia contact index queries. ACL is enforced server-side: only contacts where allowedAccountIds contains accountId (from auth) are returned. Default sort when no sort* field is set: name ASC, then email ASC. When a sort* field is set, it is the primary sort; remaining defaults are applied as tie breakers. At most one primary sort* should be set. Searchable facet typeahead (owner.name, tags) is done client-side on the returned facet buckets.

Request Body schema: application/json
required
accountId
required
string <int64>

Must match auth. Used for the allowedAccountIds ACL filter.

active
required
boolean (filterOnly facets)

filterOnly facet. Unset = no filter.

contactPersonsHasEmail
required
boolean

Maps to contactPersons.hasEmail. filterOnly facet. Unset = no filter.

hasEmail
required
boolean

filterOnly facet. Unset = no filter.

includeFacets
required
boolean

When true, response includes facet buckets for non-filterOnly facets (industries, preferredCommunicationChannels, types, ownerNames, tags).

industries
required
Array of strings (not searchable facets)
Items Enum: "INDUSTRY_UNDEFINED_VALUE" "INDUSTRY_LIVING_FURNISHING_HOUSEHOLD_APPLIANCES" "INDUSTRY_LIVING_FURNISHING_MAINTENANCE" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DESIGN" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DECORATION" "INDUSTRY_LIVING_FURNISHING_KITCHEN_FACILITIES" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_TRADING" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_MANAGEMENT" "INDUSTRY_LIVING_FURNISHING_FURNITURE" "INDUSTRY_LIVING_FURNISHING_CLEANING" "INDUSTRY_LIVING_FURNISHING_KEY_SERVICE" "INDUSTRY_LIVING_FURNISHING_BLINDS_AND_SHUTTERS" "INDUSTRY_LIVING_FURNISHING_CARPETS" "INDUSTRY_LIVING_FURNISHING_MOVING" "INDUSTRY_LIVING_FURNISHING_CURTAINS" "INDUSTRY_LIVING_FURNISHING_OTHER" "INDUSTRY_BUILD_RENOVATE_ARCHITECTURE" "INDUSTRY_BUILD_RENOVATE_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ROOFING" "INDUSTRY_BUILD_RENOVATE_FLOORING_WALL_COVERINGS" "INDUSTRY_BUILD_RENOVATE_PLASTERER" "INDUSTRY_BUILD_RENOVATE_HEATING" "INDUSTRY_BUILD_RENOVATE_WOOD_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ENGINEERING" "INDUSTRY_BUILD_RENOVATE_PAINTER" "INDUSTRY_BUILD_RENOVATE_METAL_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_SANITARY" "INDUSTRY_BUILD_RENOVATE_LOCKSMITH" "INDUSTRY_BUILD_RENOVATE_JOINERY" "INDUSTRY_BUILD_RENOVATE_PLUMBING" "INDUSTRY_BUILD_RENOVATE_CARPENTRY" "INDUSTRY_BUILD_RENOVATE_ELECTRICIAN" "INDUSTRY_BUILD_RENOVATE_CRAFTSMAN" "INDUSTRY_BUILD_RENOVATE_OTHER" "INDUSTRY_FINANCIAL_LAW_ADVOCACY" "INDUSTRY_FINANCIAL_LAW_BANK" "INDUSTRY_FINANCIAL_LAW_ACCOUNTING" "INDUSTRY_FINANCIAL_LAW_FINANCIAL_CONSULTING" "INDUSTRY_FINANCIAL_LAW_NOTARY" "INDUSTRY_FINANCIAL_LAW_LAWYER" "INDUSTRY_FINANCIAL_LAW_TAX_CONSULTING" "INDUSTRY_FINANCIAL_LAW_TRUSTEESHIP" "INDUSTRY_FINANCIAL_LAW_ASSET_MANAGEMENT" "INDUSTRY_FINANCIAL_LAW_INSURANCE" "INDUSTRY_FINANCIAL_LAW_OTHER" "INDUSTRY_GARDEN_PLANTS_FLORIST" "INDUSTRY_GARDEN_PLANTS_HORTICULTURE" "INDUSTRY_GARDEN_PLANTS_GARDEN_MAINTENANCE" "INDUSTRY_GARDEN_PLANTS_NURSERY" "INDUSTRY_GARDEN_PLANTS_DUMPSTER_SERVICE" "INDUSTRY_GARDEN_PLANTS_OTHER" "INDUSTRY_OTHER_METER_READING" "INDUSTRY_OTHER_FACILITY_MANAGEMENT" "INDUSTRY_OTHER_MAINTENANCE_INSTALLATION" "INDUSTRY_OTHER_BUILDING_SERVICES_ENGINEERING" "INDUSTRY_OTHER_KEY_SERVICE" "INDUSTRY_OTHER_CLEANING" "INDUSTRY_OTHER_WHITE_GOODS" "INDUSTRY_OTHER_OTHER" "INDUSTRY_OTHER_FIRE_PROTECTION" "INDUSTRY_BUILD_RENOVATE_FACADES" "INDUSTRY_OTHER_ELECTRICITY_PLANT" "INDUSTRY_OTHER_WATERWORKS" "INDUSTRY_OTHER_SWEEPINGS" "INDUSTRY_OTHER_ANTENNA_SYSTEM" "INDUSTRY_OTHER_PEST_CONTROL" "INDUSTRY_FINANCIAL_LAW_PUBLIC_SECTOR" "INDUSTRY_BUILD_RENOVATE_DISTRICT_HEATING" "INDUSTRY_BUILD_RENOVATE_AIR_CONDITIONING" "INDUSTRY_BUILD_RENOVATE_GARAGE_GATES" "INDUSTRY_BUILD_RENOVATE_MOLD_CONTROL" "INDUSTRY_OTHER_MARKINGS" "INDUSTRY_BUILD_RENOVATE_JOINTS" "INDUSTRY_OTHER_OIL" "INDUSTRY_BUILD_RENOVATE_LIFT_SERVICE" "INDUSTRY_OTHER_WATER_TREATMENT" "INDUSTRY_OTHER_ADVERTISING" "INDUSTRY_OTHER_GROCERIES" "INDUSTRY_OTHER_CAR_DEALERSHIP" "INDUSTRY_OTHER_STATIONERY_SHOP" "INDUSTRY_BUILD_GLAZIER" "INDUSTRY_BUILD_SCAFFOLDER" "INDUSTRY_OTHER_CHIMNEY_SWEEPER" "INDUSTRY_OTHER_ENGRAVING" "INDUSTRY_BUILD_MASONRY" "INDUSTRY_CONSTRUCTION_MANAGEMENT" "INDUSTRY_SEWER_CLEANING" "INDUSTRY_NATURE_CONSERVATION" "INDUSTRY_GEOMATICS" "INDUSTRY_DECONSTRUCTION" "INDUSTRY_GEOLOGIST" "INDUSTRY_POLLUTANT_EXPERT" "INDUSTRY_INSULATION" "INDUSTRY_LOCKING_SYSTEMS"

Not-searchable facet. Empty = no filter.

isCompany
required
boolean

filterOnly facet. Unset = no filter.

isEmployee
required
boolean

filterOnly facet. Unset = no filter.

isOnlyInterestedParty
required
boolean

filterOnly facet. Unset = no filter.

isOwner
required
boolean

filterOnly facet. Unset = no filter.

isTenant
required
boolean

filterOnly facet. Unset = no filter.

itemsPerPage
required
integer <int32>

Only used when page is set.

ownerIds
required
Array of strings <int64> [ items <int64 > ]

Maps to owner.id. filterOnly facet. Empty = no filter.

ownerNames
required
Array of strings (searchable facets)

Maps to owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

page
required
integer <int32>

1-based. Leave out or set to 0 to disable pagination.

preferredCommunicationChannels
required
Array of strings (v2PreferredCommunicationChannel)
Items Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"

Not-searchable facet. Empty = no filter.

query
required
string

Free-text search over searchable attributes (includes owner.name and tags). Empty = filter/sort only.

sortEmail
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortNumericId
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortOwnerName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
tags
required
Array of strings

Searchable facet; typeahead is client-side. Empty = no filter.

types
required
Array of strings (contactcontactv2Type)
Items Enum: "NONE" "LANDLORD" "CLIENT" "TENANT" "EMPLOYEE" "CARETAKER" "SERVICE_PROVIDER" "INTERESTED_PARTY" "BANK" "INSURANCE" "REAL_ESTATE_MANAGER" "CRAFTSMAN" "AUTHORITY" "ACCOUNTANT" "MARKETER" "CONDOMINIUM_OWNER" "SUB_TENANT" "REPRESENTATION" "COOPERATIVE" "SALE" "EXTERNAL_DEBTOR" "GUARANTOR" "REVISOR" "DELEGATE" "BOARD" "OWNER"

Not-searchable facet. Empty = no filter.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "active": true,
  • "contactPersonsHasEmail": true,
  • "hasEmail": true,
  • "includeFacets": true,
  • "industries": [
    ],
  • "isCompany": true,
  • "isEmployee": true,
  • "isOnlyInterestedParty": true,
  • "isOwner": true,
  • "isTenant": true,
  • "itemsPerPage": 0,
  • "ownerIds": [
    ],
  • "ownerNames": [
    ],
  • "page": 0,
  • "preferredCommunicationChannels": [
    ],
  • "query": "string",
  • "sortEmail": "UNDEFINED_SORT_ORDER",
  • "sortName": "UNDEFINED_SORT_ORDER",
  • "sortNumericId": "UNDEFINED_SORT_ORDER",
  • "sortOwnerName": "UNDEFINED_SORT_ORDER",
  • "tags": [
    ],
  • "types": [
    ]
}

Response samples

Content type
application/json
{
  • "facets": {
    },
  • "hits": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

List objects from the search read model

Paginated, filterable and searchable object list replacing Algolia object index queries. ACL is enforced server-side: only objects where allowedAccountIds contains accountId (from auth) are returned. Free-text query searches numericId, number, publicId, name, address.street/streetNumber/streetAddition/zip/city, tenancy.tenants.name, networkPartners.name, condominium.owner, condominium.tenants and tenancy.subTenants.tenant.name. Default sort when no sort* field is set: inactive ASC, then categorySortValue ASC, then floorSortValue ASC, then name ASC. When a sort* field is set, it is the primary sort; remaining defaults are applied as tie breakers. At most one primary sort* should be set. Searchable facet typeahead is done client-side on the returned facet buckets.

Request Body schema: application/json
required
accountId
required
string <int64>

Must match auth. Used for the allowedAccountIds ACL filter.

assigneeAccountingNames
required
Array of strings

Maps to assignees.accounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAdministrationNames
required
Array of strings

Maps to assignees.administration.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAssetNames
required
Array of strings

Maps to assignees.asset.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeMarketingNames
required
Array of strings

Maps to assignees.marketing.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeOwnerNames
required
Array of strings

Maps to assignees.owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeViewingAppointmentNames
required
Array of strings (facets without free-text typeahead)

Maps to assignees.viewingAppointment.name. Not-searchable facet. Empty = no filter.

buildingIds
required
Array of strings (filterOnly)

Maps to buildingId. filterOnly facet. Empty = no filter.

buildingNames
required
Array of strings

Maps to building.name. Searchable facet; typeahead is client-side. Empty = no filter.

categories
required
Array of strings (objectCategory)
Items Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"

Maps to category. Not-searchable facet. Empty = no filter.

cities
required
Array of strings (searchable facets (typeahead client-side))

Maps to address.city. Searchable facet; typeahead is client-side. Empty = no filter.

condominiumOwnership
required
boolean

Maps to condominiumOwnership. filterOnly facet. Unset = no filter.

floors
required
Array of numbers <double> [ items <double > ]

Maps to floor (decimalFloor). Not-searchable facet. Empty = no filter.

futureRentalStatuses
required
Array of strings

Maps to futureRentalStatus. Not-searchable facet. Empty = no filter.

inMarketingStatuses
required
Array of strings

Maps to inMarketingStatus (e.g. online/offline/no). Searchable facet; typeahead is client-side. Empty = no filter.

inactive
required
boolean

Maps to inactive. filterOnly facet. Unset = no filter.

includeFacets
required
boolean

When true, response includes facet buckets. filterOnly facets are not returned.

itemsPerPage
required
integer <int32>

Only used when page is set.

marketingStatusInMarketing
required
boolean

Maps to marketingStatus.inMarketing. Not-searchable facet. Unset = no filter.

marketingStatusNewInMarketing
required
boolean

Maps to marketingStatus.newInMarketing. Not-searchable facet. Unset = no filter.

marketingStatusPublished
required
boolean

Maps to marketingStatus.published. Not-searchable facet. Unset = no filter.

marketingStatusStatuses
required
Array of strings

Maps to marketingStatus.status. Not-searchable facet. Empty = no filter.

marketingStatusVacantAts
required
Array of strings <int64> [ items <int64 > ]

Maps to marketingStatus.vacantAt. filterOnly facet. Empty = no filter.

networkPartnerAccountingNames
required
Array of strings

Maps to networkPartnerAccounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerAdministrationNames
required
Array of strings

Maps to networkPartnerAdministration.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerAssetNames
required
Array of strings

Maps to networkPartnerAsset.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerCombinedIds
required
Array of strings

Maps to networkPartners.combinedId. filterOnly facet. Empty = no filter.

networkPartnerMarketingNames
required
Array of strings

Maps to networkPartnerMarketing.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerNames
required
Array of strings

Maps to networkPartners.name. Searchable facet; typeahead is client-side. Empty = no filter.

ownerNames
required
Array of strings

Maps to owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

page
required
integer <int32>

1-based. Leave out or set to 0 to disable pagination.

preferredCommunicationChannels
required
Array of strings (v2PreferredCommunicationChannel)
Items Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"

Maps to preferredCommunicationChannel. Not-searchable facet. Empty = no filter.

propertyNames
required
Array of strings

Maps to property.name. Searchable facet; typeahead is client-side. Empty = no filter.

query
required
string

Free-text search over numericId, number, publicId, name, address.street/streetNumber/streetAddition/zip/city, tenancy.tenants.name, networkPartners.name, condominium.owner, condominium.tenants and tenancy.subTenants.tenant.name. Empty = filter/sort only.

requestStatisticsStatuses
required
Array of strings

Maps to requestStatistics.status. Not-searchable facet. Empty = no filter.

rooms
required
Array of numbers <double> [ items <double > ]

Maps to rooms. Searchable facet; typeahead is client-side. Empty = no filter.

sortCategory
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortFloor
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortInactive
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
statuses
required
Array of strings

Maps to status. Not-searchable facet. Empty = no filter.

subCategories
required
Array of strings (- ATELIER: SwissRETS fields (can also contain IDX fields) - AGRICULTURAL_INSTALLATION: IDX fields)
Items Enum: "UNDEFINED_SUB_CATEGORY" "ATELIER" "ATTIC_FLAT" "BAR" "CAFE" "CAR_REPAIR_SHOP" "CASTLE" "CHALET" "EARTH_SHELTERED_DWELLING" "DETACHED_HOUSE" "DOCTORS_OFFICE" "DUPLEX_HOUSE" "FARM_HOUSE" "FURNISHED_FLAT" "GRANNY_FLAT" "HOBBY_ROOM" "HOTEL" "LOFT" "MAISONETTE" "MULTIPLEX_HOUSE" "OFFICE" "ONE_ROOM_FLAT" "RESTAURANT" "RETAIL_LOCATION" "ROOF_FLAT" "ROW_HOUSE" "RUSTICO" "SINGLE_ROOM" "STOECKLI" "STEPPED_FLAT" "STEPPED_HOUSE" "VILLA" "WORKSHOP" "AGRICULTURAL_INSTALLATION" "MOUNTAIN_FARM" "FARM" "DUPLEX" "STUDIO" "TERRACE_FLAT" "BACHELOR_FLAT" "ATTIC" "ALOTTMENT_GARDEN" "CLUB" "CASINO" "MOVIE" "SQUASH" "INDOOR_TENNIS" "TENNIS" "SPORTS_HALL" "CAMP_GROUND" "OUTDOOR_SWIMMING_POOL" "INDOOR_SWIMMING_POOL" "GOLF_COURSE" "MOTEL" "PUB" "SINGLE_HOUSE" "BIFAMILIAR_HOUSE" "TERRANCE_HOUSE" "MULTIPLE_DWELLING" "CAVE_HOUSE" "SHOP" "ADVERTISING_AREA" "COMMERCIAL_SUB_CATEGORY" "STORAGE_ROOM" "PRACTICE" "KIOSK" "GARDENING" "FUEL_STATION" "CHEESE_FACTORY" "BUTCHER" "BAKERY" "HAIRDRESSER" "SHOPPING_CENTER" "FACTORY" "INDUSTRIAL_OBJECT" "ARCADE" "LIVING_COMMERCIAL_BUILDING" "LIBRARY" "HOSPITAL" "LABORATORY" "MINI_GOLD_COURSE" "NURSING_HOME" "RIDING_HALL" "SANATORIUM" "PARTY_ROOM" "SAUNA" "SOLARIUM" "CARPENTRY_SHOP" "OLD_AGE_HOME" "DEPARTMENT_STORE" "HOME" "DISPLAY_WINDOW" "PARKING_GARAGE" "PARKING_SURFACE" "OPEN_SLOT" "COVERED_SLOT" "SINGLE_GARAGE" "DOUBLE_GARAGE" "UNDERGROUND_SLOT" "BOAT_DRY_DOCK" "BOAT_LANDING_STAGE" "COVERED_PARKING_PLACE_BIKE" "OUTDOOR_PARKING_PLACE_BIKE" "HORSE_BOX" "BOAT_MOORING" "BUILDING_LAND" "AGRICULTURAL_LAND" "COMMERCIAL_LAND" "INDUSTRIAL_LAND" "CELLAR_COMPARTMENT" "ATTIC_COMPARTMENT" "OTHER" "VISITOR_PARKING_LOT" "CARETAKER_ROOM" "FITNESS_CENTER" "ARCHIVE_ROOM" "ANTENNA_SYSTEM" "TRAINING_ROOM" "TOILET_FACILITY" "BICYCLE_PARKING" "HANDICAPPED_INDOOR_PARKING" "HANDICAPPED_OUTDOOR_PARKING" "DOUBLE_OUTDOOR_PARKING" "DOUBLE_INDOOR_PARKING" "JANITOR_ROOM" "LAUNDRY_ROOM" "CUSTOMER_PARKING" "RETIREMENT_APARTMENT" "STAFF_ROOM" "SERVER_ROOM" "MEETING_ROOM" "BUILDING_SERVICES" "COMMERCIAL_STORAGE_ROOM" "ELECTRIC_PARKING_SPACE"

Maps to subCategories. Searchable facet; typeahead is client-side. Empty = no filter.

tags
required
Array of strings

Maps to tags. Searchable facet; typeahead is client-side. Empty = no filter.

tenancyActivatedAndTenancy
required
boolean

Maps to tenancy.activatedAndTenancy. filterOnly facet. Unset = no filter.

tenancyNotActivatedAndTenancy
required
boolean

Maps to tenancy.notActivatedAndTenancy. filterOnly facet. Unset = no filter.

tenantNames
required
Array of strings

Maps to tenancy.tenants.name. Searchable facet; typeahead is client-side. Empty = no filter.

zips
required
Array of strings

Maps to address.zip. Searchable facet; typeahead is client-side. Empty = no filter.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "assigneeAccountingNames": [
    ],
  • "assigneeAdministrationNames": [
    ],
  • "assigneeAssetNames": [
    ],
  • "assigneeMarketingNames": [
    ],
  • "assigneeOwnerNames": [
    ],
  • "assigneeViewingAppointmentNames": [
    ],
  • "buildingIds": [
    ],
  • "buildingNames": [
    ],
  • "categories": [
    ],
  • "cities": [
    ],
  • "condominiumOwnership": true,
  • "floors": [
    ],
  • "futureRentalStatuses": [
    ],
  • "inMarketingStatuses": [
    ],
  • "inactive": true,
  • "includeFacets": true,
  • "itemsPerPage": 0,
  • "marketingStatusInMarketing": true,
  • "marketingStatusNewInMarketing": true,
  • "marketingStatusPublished": true,
  • "marketingStatusStatuses": [
    ],
  • "marketingStatusVacantAts": [
    ],
  • "networkPartnerAccountingNames": [
    ],
  • "networkPartnerAdministrationNames": [
    ],
  • "networkPartnerAssetNames": [
    ],
  • "networkPartnerCombinedIds": [
    ],
  • "networkPartnerMarketingNames": [
    ],
  • "networkPartnerNames": [
    ],
  • "ownerNames": [
    ],
  • "page": 0,
  • "preferredCommunicationChannels": [
    ],
  • "propertyNames": [
    ],
  • "query": "string",
  • "requestStatisticsStatuses": [
    ],
  • "rooms": [
    ],
  • "sortCategory": "UNDEFINED_SORT_ORDER",
  • "sortFloor": "UNDEFINED_SORT_ORDER",
  • "sortInactive": "UNDEFINED_SORT_ORDER",
  • "sortName": "UNDEFINED_SORT_ORDER",
  • "statuses": [
    ],
  • "subCategories": [
    ],
  • "tags": [
    ],
  • "tenancyActivatedAndTenancy": true,
  • "tenancyNotActivatedAndTenancy": true,
  • "tenantNames": [
    ],
  • "zips": [
    ]
}

Response samples

Content type
application/json
{
  • "facets": {
    },
  • "hits": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

List properties from the search read model

Paginated, filterable and searchable property list replacing Algolia property index queries. ACL is enforced server-side: only properties where allowedAccountIds contains accountId (from auth) are returned. Free-text query searches numericId, name, address.zip and address.city. Default sort when no sort* field is set: owner.name ASC, then name ASC, then address.city ASC, then address.zip ASC, then buildingCount ASC. When a sort* field is set, it is the primary sort; remaining defaults are applied as tie breakers. At most one primary sort* should be set. Searchable facet typeahead (cities, zips, assignee/owner/network-partner names) is done client-side on the returned facet buckets.

Request Body schema: application/json
required
accountId
required
string <int64>

Must match auth. Used for the allowedAccountIds ACL filter.

assigneeAccountingNames
required
Array of strings

Maps to assignees.accounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAdministrationNames
required
Array of strings

Maps to assignees.administration.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAssetNames
required
Array of strings

Maps to assignees.asset.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeOwnerNames
required
Array of strings

Maps to assignees.owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

buildingCounts
required
Array of integers <int32> (facets without free-text typeahead) [ items <int32 > ]

Maps to buildingCount. Not searchable for typeahead. Empty = no filter.

cities
required
Array of strings (searchable facets (typeahead client-side))

Maps to address.city. Searchable facet; typeahead is client-side. Empty = no filter.

includeFacets
required
boolean

When true, response includes facet buckets (cities, zips, assignee/owner/network-partner names, buildingCounts, types). filterOnly networkPartnerCombinedIds are not returned.

itemsPerPage
required
integer <int32>

Only used when page is set.

networkPartnerAccountingNames
required
Array of strings

Maps to networkPartnerAccounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerAssetNames
required
Array of strings

Maps to networkPartnerAsset.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerCombinedIds
required
Array of strings (filterOnly)

Maps to networkPartners.combinedId. filterOnly facet. Empty = no filter.

ownerNames
required
Array of strings

Maps to owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

page
required
integer <int32>

1-based. Leave out or set to 0 to disable pagination.

query
required
string

Free-text search over numericId, name, address.zip and address.city. Empty = filter/sort only.

sortBuildingCount
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortCity
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortOwnerName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortZip
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
types
required
Array of strings (propertyv2PropertyType)
Items Enum: "PROPERTY_TYPE_UNDEFINED" "PROPERTY_TYPE_RENTAL" "PROPERTY_TYPE_CONDOMINIUM_OWNERSHIP" "PROPERTY_TYPE_COOPERATIVE"

Maps to type. Not-searchable facet. Empty = no filter.

zips
required
Array of strings

Maps to address.zip. Searchable facet; typeahead is client-side. Empty = no filter.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "assigneeAccountingNames": [
    ],
  • "assigneeAdministrationNames": [
    ],
  • "assigneeAssetNames": [
    ],
  • "assigneeOwnerNames": [
    ],
  • "buildingCounts": [
    ],
  • "cities": [
    ],
  • "includeFacets": true,
  • "itemsPerPage": 0,
  • "networkPartnerAccountingNames": [
    ],
  • "networkPartnerAssetNames": [
    ],
  • "networkPartnerCombinedIds": [
    ],
  • "ownerNames": [
    ],
  • "page": 0,
  • "query": "string",
  • "sortBuildingCount": "UNDEFINED_SORT_ORDER",
  • "sortCity": "UNDEFINED_SORT_ORDER",
  • "sortName": "UNDEFINED_SORT_ORDER",
  • "sortOwnerName": "UNDEFINED_SORT_ORDER",
  • "sortZip": "UNDEFINED_SORT_ORDER",
  • "types": [
    ],
  • "zips": [
    ]
}

Response samples

Content type
application/json
{
  • "facets": {
    },
  • "hits": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

List tenancies from the search read model

Paginated, filterable and searchable tenancy list replacing Algolia tenancy index queries. ACL is enforced server-side: only tenancies where allowedAccountIds contains accountId (from auth) are returned. Free-text query searches tenants.name, subTenants.tenant.name, numericId, obj.numericId, obj.address.street/streetNumber/mailbox/subUnit/streetAddition/zip/city. Default sort when no sort* field is set: tenantNameSortValue ASC, then obj.categorySortValue ASC, then obj.floorSortValue ASC, then startingAtTimestamp ASC. When a sort* field is set, it is the primary sort; remaining defaults are applied as tie breakers. At most one primary sort* should be set. Searchable facet typeahead is done client-side on the returned facet buckets.

Request Body schema: application/json
required
accountId
required
string <int64>

Must match auth. Used for the allowedAccountIds ACL filter.

assigneeAccountingNames
required
Array of strings

Maps to obj.assignees.accounting.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAdministrationNames
required
Array of strings

Maps to obj.assignees.administration.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeAssetNames
required
Array of strings

Maps to obj.assignees.asset.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeMarketingNames
required
Array of strings

Maps to obj.assignees.marketing.name. Searchable facet; typeahead is client-side. Empty = no filter.

assigneeOwnerNames
required
Array of strings

Maps to obj.assignees.owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

buildingNames
required
Array of strings (searchable facets (typeahead client-side))

Maps to building.name. Searchable facet; typeahead is client-side. Empty = no filter.

categories
required
Array of strings (facets without free-text typeahead)
Items Enum: "UNDEFINED_CATEGORY" "APARTMENT" "HOUSE" "COMMERCIAL" "GASTRONOMY" "GARDEN" "PARKING_SPACE" "SECONDARY_ROOM" "PLOT" "AGRICULTURE"

Maps to obj.category. Not-searchable facet. Empty = no filter.

cities
required
Array of strings

Maps to obj.address.city. Searchable facet; typeahead is client-side. Empty = no filter.

closed
required
boolean (filterOnly)

Maps to closed. filterOnly facet. Unset = no filter.

endingAtFilters
required
Array of strings

Maps to endingAtFilter (month/year, e.g. 3/2024). Searchable facet; typeahead is client-side. Empty = no filter.

required
Array of objects (searchObjectHitDate)

Maps to endingAt (year/month/day). filterOnly facet. Empty = no filter.

floors
required
Array of numbers <double> [ items <double > ]

Maps to obj.floor (decimalFloor). Not-searchable facet. Empty = no filter.

includeFacets
required
boolean

When true, response includes facet buckets. filterOnly facets are not returned.

itemsPerPage
required
integer <int32>

Only used when page is set.

networkPartnerAssetNames
required
Array of strings

Maps to obj.networkPartnerAsset.name. Searchable facet; typeahead is client-side. Empty = no filter.

networkPartnerCombinedIds
required
Array of strings

Maps to obj.networkPartners.combinedId. filterOnly facet. Empty = no filter.

objectIds
required
Array of strings

Maps to obj.id. filterOnly facet. Empty = no filter.

ownerNames
required
Array of strings

Maps to owner.name. Searchable facet; typeahead is client-side. Empty = no filter.

page
required
integer <int32>

1-based. Leave out or set to 0 to disable pagination.

preferredCommunicationChannels
required
Array of strings (v2PreferredCommunicationChannel)
Items Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"

Maps to preferredCommunicationChannel. Not-searchable facet. Empty = no filter.

propertyNames
required
Array of strings

Maps to property.name. Searchable facet; typeahead is client-side. Empty = no filter.

query
required
string

Free-text search over tenants.name, subTenants.tenant.name, numericId, obj.numericId, obj.address.street/streetNumber/mailbox/subUnit/streetAddition/zip/city. Empty = filter/sort only.

rooms
required
Array of numbers <double> [ items <double > ]

Maps to obj.rooms. Searchable facet; typeahead is client-side. Empty = no filter.

sortCategory
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortFloor
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortStartingAt
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
sortTenantName
required
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
startingAtFilters
required
Array of strings

Maps to startingAtFilter (month/year, e.g. 3/2024). Searchable facet; typeahead is client-side. Empty = no filter.

required
Array of objects (searchObjectHitDate)

Maps to startingAt (year/month/day). filterOnly facet. Empty = no filter.

statuses
required
Array of strings

Maps to status (denormalized label, e.g. current/temporary/closed). Not-searchable facet. Empty = no filter.

tags
required
Array of strings

Maps to obj.tags. Searchable facet; typeahead is client-side. Empty = no filter.

vacancy
required
boolean

Maps to vacancy. filterOnly facet. Unset = no filter.

zips
required
Array of strings

Maps to obj.address.zip. Searchable facet; typeahead is client-side. Empty = no filter.

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "assigneeAccountingNames": [
    ],
  • "assigneeAdministrationNames": [
    ],
  • "assigneeAssetNames": [
    ],
  • "assigneeMarketingNames": [
    ],
  • "assigneeOwnerNames": [
    ],
  • "buildingNames": [
    ],
  • "categories": [
    ],
  • "cities": [
    ],
  • "closed": true,
  • "endingAtFilters": [
    ],
  • "endingAts": [
    ],
  • "floors": [
    ],
  • "includeFacets": true,
  • "itemsPerPage": 0,
  • "networkPartnerAssetNames": [
    ],
  • "networkPartnerCombinedIds": [
    ],
  • "objectIds": [
    ],
  • "ownerNames": [
    ],
  • "page": 0,
  • "preferredCommunicationChannels": [
    ],
  • "propertyNames": [
    ],
  • "query": "string",
  • "rooms": [
    ],
  • "sortCategory": "UNDEFINED_SORT_ORDER",
  • "sortFloor": "UNDEFINED_SORT_ORDER",
  • "sortStartingAt": "UNDEFINED_SORT_ORDER",
  • "sortTenantName": "UNDEFINED_SORT_ORDER",
  • "startingAtFilters": [
    ],
  • "startingAts": [
    ],
  • "statuses": [
    ],
  • "tags": [
    ],
  • "vacancy": true,
  • "zips": [
    ]
}

Response samples

Content type
application/json
{
  • "facets": {
    },
  • "hits": [
    ],
  • "totalCount": 0,
  • "totalPageCount": 0
}

Check whether search index updates are ongoing

Returns whether search index updates are still ongoing for any of the given entity IDs.

Request Body schema: application/json
required
entityIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "entityIds": [
    ]
}

Response samples

Content type
application/json
{
  • "ongoing": true
}

TableService

Load table settings for an account

Returns all saved table settings (table name and column layout) for the given accountId.

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "tableSettings": [
    ]
}

Save table settings for an account

Saves the column layout for the given accountId and table name. Returns the saved table settings.

Request Body schema: application/json
required
accountId
required
string <int64>
columns
required
Array of strings
table
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "columns": [
    ],
  • "table": "string"
}

Response samples

Content type
application/json
{
  • "tableSettings": {
    }
}