Search Contacts
n8n-nodes-base.httpRequest
Search contacts based on combinations of advanced filters including email, phone, tags, and custom fields.
💡 Use Cases
- Find contacts by criteria
- Advanced contact filtering
- Locate specific contacts
📚 API Documentation
Reference documentation for this API endpoint:
🔗 https://marketplace.gohighlevel.com/docs/ghl/contacts/search-contacts ↗📋 Node Configuration
{
"nodes": [
{
"parameters": {
"content": "## 🔍 Search Contacts\n\n**Usage:**\nSearch contacts based on combinations of advanced filters.\n\n**Optional Filters:**\n- `email`: Search by email address\n- `phone`: Search by phone number\n- `name`: Search by contact name\n- `tags`: Filter by tags\n- `customFields`: Filter by custom field values\n\n**Setup:**\n1. Configure GoHighLevel OAuth2 credentials\n2. Pass search filters as query parameters\n3. Node returns array of matching contacts\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-contacts",
"name": "Sticky Note"
},
{
"parameters": {
"method": "POST",
"url": "https://services.leadconnectorhq.com/contacts/search",
"authentication": "genericCredentialType",
"sendHeaders": true,
"headerParameters": {
"parameters": [
{
"name": "Version",
"value": "2021-07-28"
},
{
"name": "Content-Type",
"value": "application/json"
}
]
},
"sendBody": true,
"specifyBody": "json",
"jsonBody": "={\n \"email\": \"{{ $json.email }}\",\n \"phone\": \"{{ $json.phone }}\",\n \"name\": \"{{ $json.name }}\",\n \"tags\": {{ $json.tags }},\n \"customFields\": {{ $json.customFields }}\n}",
"options": {},
"genericAuthType": "httpHeaderAuth"
},
"id": "ghl-search-contacts-001",
"name": "GHL Search Contacts",
"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": "f211030a-db41-4a14-ac8a-e9aeac40eab2",
"meta": {
"name": "API Call Node",
"id": "api-call",
"icon": {
"svg": "
{
"subflows": [
{
"flow": [
{
"id": 827,
"module": "http:ActionSendDataBasicAuth",
"version": 3,
"parameters": {
"key": "ANONYMIZED_CREDENTIALS",
"handleErrors": false,
"useNewZLibDeCompress": true
},
"mapper": {
"ca": "",
"qs": [],
"url": "https://services.leadconnectorhq.com/contacts/search",
"data": "{\n \"email\": {{1.email}},\n \"phone\": {{1.phone}},\n \"name\": {{1.name}},\n \"tags\": {{1.tags}},\n \"customFields\": {{1.customFields}}\n}",
"gzip": true,
"method": "post",
"headers": [
{
"name": "Version",
"value": "2021-07-28"
},
{
"name": "Content-Type",
"value": "application/json"
},
{
"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 Contacts"
},
"restore": {
"expect": {
"qs": {
"mode": "chose",
"items": []
},
"method": {
"mode": "chose",
"label": "POST"
},
"headers": {
"mode": "chose",
"items": [
null,
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
}
}