ghl_user_get_by_location
Retrieve users by location ID from GoHighLevel's legacy endpoint; use /users/search instead for richer filtering and paging.
Instructions
DEPRECATED per spec — superseded by GET /users/search (v3), which supports the same locationId filter plus richer query/paging options.
[DEPRECATED per official docs — prefer the documented replacement if one exists.]
[LEGACY FALLBACK — this endpoint is no longer in the live v3 docs (checked 2026-10-28) but is still served under the legacy Version header. Expect removal; prefer a current equivalent.]
Get User by Location
Deprecated. Use GET /users/search instead. Pass locationId as a query parameter to filter results by location, along with the required companyId and other search filters as needed.
Endpoint: GET /users/ (Version header: 2021-07-28; source: users.json)
Requires a Sub-Account (location) token.
OAuth scopes: users.readonly
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"locationId": "<locationId>"
},
"name": "ghl_user_get_by_location"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locationId | Yes |