Skip to main content

Get GlobalSearch

GET 
/miscellaneous/globalSearch

This method can be used to search for workspaces, companies or locations by defining some filtering parameter.

The 'filter' parameter gets used only for the name when at least 3 characters are defined. Nevertheless you can use it to search for external IDs, even those having less than 3 characters.

You can multi-select 'contextTypes', 'productTypes' or 'statuses'. When none is selected, no limitations regarding those types getting applied.

When a 'filter' is provided, each result includes a 'matchingKeys' array that tells you which fields matched your search terms — for example ['name'] if the name matched, or ['name', 'location_id'] if two different fields were hit. Results that match all search words will be returned, and 'matchingKeys' will list every field that contributed to the match.

Request​

Responses​

OK