GET api/GlobalSearch?term={term}&excludeDeleted={excludeDeleted}&excludeArchived={excludeArchived}&lastUpdated={lastUpdated}

The main endpoint for a global search across all entities in the system.

Request Information

URI Parameters

Name	Description	Type	Additional information
term	Search term	string	Required
excludeDeleted		boolean	Default value is False
excludeArchived		boolean	Default value is False
lastUpdated	Get results from the last updated date	date	None.

Body Parameters

None.

Response Information

Resource Description

GlobalSearchResponseDataContract

Name	Description	Type	Additional information
Groups		PagedCollectionDataContractOfGlobalSearchGroupResultDataContract	None.
Companies		PagedCollectionDataContractOfGlobalSearchGroupResultDataContract	None.
People		PagedCollectionDataContractOfGlobalSearchPersonResultDataContract	None.
Properties		PagedCollectionDataContractOfGlobalSearchPropertyResultDataContract	None.
Auctions		PagedCollectionDataContractOfGlobalSearchAuctionResultDataContract	None.

Response Formats