Search Locations Tool
search-locationsLists physical locations in the authenticated workspace. Use to search locations in the connected business. Returns count, locations, scope.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search-locations"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of location records to return; defaults to 20. | |
| query | No | Location name to search for. | |
| status | No | active, archived, or all. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Count for the returned result. | |
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. | |
| locations | Yes | Bounded locations records returned by this tool. |