Search Users
n8n-nodes-base.httpRequest
Searches for users across the company with various filtering options.
💡 Use Cases
- Find users
- Filter by role
📚 API Documentation
Reference documentation for this API endpoint:
🔗 https://marketplace.gohighlevel.com/docs/ghl/users/search-users ↗📋 Node Configuration
{
"nodes": [
{
"parameters": {
"content": "## 🔍 Search Users\n\n**Usage:**\nSearches for users across the company with various filtering options.\n\n**Required Input:**\n- `companyId`: Company ID\n\n**Optional Fields:**\n- `query`: Search query string (searches name, email)\n- `role`: Filter by role ID\n- `locationId`: Filter by location ID\n- `limit`: Number of users to return (default: 20)\n- `skip`: Number of users to skip for pagination\n\n**Setup:**\n1. Configure HTTP Header Auth with GHL Private Token\n2. Pass companyId in incoming data\n3. Add search query or filters as needed\n4. Node returns matching users\n\n**Output:**\nReturns array of users matching the search criteria with full user details including permissions and assigned locations.\n\n**Credential Setup (HTTP Header Auth):**\n1. In n8n, go to Credentials → Add Credential\n2. Select \"Header Auth\"\n3. Set Name: `Authorization`\n4. Set Value: `Bearer YOUR_ACCESS_TOKEN`\n5. Get your token from GHL Settings → Integrations → Private Integrations",
"height": 238,
"width": 389,
"color": 4
},
"type": "n8n-nodes-base.stickyNote",
"position": [
96,
332
],
"typeVersion": 1,
"id": "sticky-ghl-search-users",
"name": "Sticky Note"
},
{
"parameters": {
"method": "GET",
"url": "=https://services.leadconnectorhq.com/users/search?companyId={{ $json.companyId }}{{ $json.query ? '&query=' + $json.query : '' }}{{ $json.role ? '&role=' + $json.role : '' }}{{ $json.locationId ? '&locationId=' + $json.locationId : '' }}{{ $json.limit ? '&limit=' + $json.limit : '' }}{{ $json.skip ? '&skip=' + $json.skip : '' }}",
"authentication": "genericCredentialType",
"genericAuthType": "httpHeaderAuth",
"sendHeaders": true,
"headerParameters": {
"parameters": [
{
"name": "Version",
"value": "2021-07-28"
}
]
},
"options": {}
},
"id": "ghl-search-users-001",
"name": "GHL Search Users",
"type": "n8n-nodes-base.httpRequest",
"typeVersion": 4.1,
"position": [
368,
400
],
"credentials": {
"httpHeaderAuth": {
"id": "GHL_Private_Token",
"name": "GoHighLevel Private Integration"
}
}
}
],
"connections": {},
"pinData": {},
"meta": {
"templateCredsSetupCompleted": true,
"instanceId": "751aeba95f3d1aebe5a6ebe9d20293dd6c0f61b00ef369c580f0dc54913f5fcb"
}
}
[
{
"id": "ed74651b-8202-4f29-a924-3eb37f429f78",
"meta": {
"name": "API Call Node",
"id": "api-call",
"icon": {
"svg": "
{
"subflows": [
{
"flow": [
{
"id": 646,
"module": "http:ActionSendDataBasicAuth",
"version": 3,
"parameters": {
"key": "ANONYMIZED_CREDENTIALS",
"handleErrors": false,
"useNewZLibDeCompress": true
},
"mapper": {
"ca": "",
"qs": [],
"url": "https://services.leadconnectorhq.com/users/search?companyId={{1.companyId}}{{ $json.query ? '&query=' + $json.query : '' }}{{ $json.role ? '&role=' + $json.role : '' }}{{ $json.locationId ? '&locationId=' + $json.locationId : '' }}{{ $json.limit ? '&limit=' + $json.limit : '' }}{{ $json.skip ? '&skip=' + $json.skip : '' }}",
"data": "",
"gzip": true,
"method": "get",
"headers": [
{
"name": "Version",
"value": "2021-07-28"
},
{
"name": "Authorization",
"value": "Bearer {{ANONYMIZED_TOKEN}}"
}
],
"timeout": "",
"useMtls": false,
"bodyType": "raw",
"contentType": "application/json",
"serializeUrl": false,
"shareCookies": false,
"parseResponse": true,
"followRedirect": true,
"useQuerystring": false,
"followAllRedirects": false,
"rejectUnauthorized": true
},
"metadata": {
"designer": {
"x": 300,
"y": 300,
"name": "Search Users"
},
"restore": {
"expect": {
"qs": {
"mode": "chose",
"items": []
},
"method": {
"mode": "chose",
"label": "GET"
},
"headers": {
"mode": "chose",
"items": [
null,
null
]
},
"bodyType": {
"label": "Raw"
},
"contentType": {
"label": "JSON (application/json)"
}
},
"parameters": {
"key": {
"label": "ANONYMIZED_CREDENTIALS"
}
}
},
"parameters": [
{
"name": "key",
"type": "keychain:basicauth",
"label": "Credentials",
"required": true
},
{
"name": "handleErrors",
"type": "boolean",
"label": "Evaluate all states as errors (except for 2xx and 3xx )",
"required": true
},
{
"name": "useNewZLibDeCompress",
"type": "hidden"
}
],
"expect": [
{
"name": "url",
"type": "url",
"label": "URL",
"required": true
},
{
"name": "serializeUrl",
"type": "boolean",
"label": "Serialize URL",
"required": true
},
{
"name": "method",
"type": "select",
"label": "Method",
"required": true,
"validate": {
"enum": [
"get",
"head",
"post",
"put",
"patch",
"delete",
"options"
]
}
},
{
"name": "headers",
"spec": [
{
"name": "name",
"type": "text",
"label": "Name",
"required": true
},
{
"name": "value",
"type": "text",
"label": "Value"
}
],
"type": "array",
"label": "Headers"
},
{
"name": "qs",
"spec": [
{
"name": "name",
"type": "text",
"label": "Name",
"required": true
},
{
"name": "value",
"type": "text",
"label": "Value"
}
],
"type": "array",
"label": "Query String"
},
{
"name": "bodyType",
"type": "select",
"label": "Body type",
"validate": {
"enum": [
"raw",
"x_www_form_urlencoded",
"multipart_form_data"
]
}
},
{
"name": "parseResponse",
"type": "boolean",
"label": "Parse response",
"required": true
},
{
"name": "contentType",
"type": "select",
"label": "Content type",
"validate": {
"enum": [
"text/plain",
"application/json",
"application/xml",
"text/xml",
"text/html",
"custom"
]
}
},
{
"name": "data",
"type": "buffer",
"label": "Request content"
}
]
}
}
]
}
],
"metadata": {
"version": 1
}
}