users_search_users
Read-onlyIdempotent
Search users in GoHighLevel by name, email, phone, role, type, or ID. Apply filters like skip, limit, and sorting to retrieve targeted user records.
Instructions
Search Users
Input Schema
TableJSON 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 | |
| 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 | |
| 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 Defaults to GHL_LOCATION_ID when omitted. | |
| sortDirection | No | The direction in which the results need to be sorted | |
| enabled2waySync | No |