ghl_user_search
Search and filter users within a company or location by name, email, phone, role, type, or IDs, with pagination and sorting.
Instructions
Search Users Endpoint: GET /users/search (Version header: v3; source: v3/users-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: users.readonly Pagination params: skip, limit — pass them to page through full result sets.
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": {
"companyId": "<companyId>"
},
"name": "ghl_user_search"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | List of User IDs to be filtered in the search | |
| role | No | Role of the users to be filtered in the search | |
| skip | No | No of results to be skipped before returning the result | 0 |
| sort | No | The field on which sort is applied in which the results need to be sorted. Default is based on the first and last name | |
| type | No | Type of the users to be filtered in the search | |
| limit | No | No of results to be limited before returning the result | 25 |
| query | No | The search term for the user is matched based on the user full name, email or phone | |
| companyId | Yes | Company ID in which the search needs to be performed | |
| locationId | No | Location ID in which the search needs to be performed | |
| sortDirection | No | The direction in which the results need to be sorted | |
| enabled2waySync | No | Filter users by whether 2-way sync is enabled |