🚀 More Vendrato tools: FunnelDupe • GHL Utils
📧

Filter Users by Email

n8n-nodes-base.httpRequest

Filters users by company ID, deleted status, and email addresses.

gohighlevel users email filter
App GoHighLevel
Category api integration
Version 1.0.0
Author Community
Credentials GoHighLevel Private Token

💡 Use Cases

📚 API Documentation

Reference documentation for this API endpoint:

🔗 https://marketplace.gohighlevel.com/docs/ghl/emails/filter-users-by-email ↗

📋 Node Configuration

{
  "nodes": [
    {
      "parameters": {
        "content": "## 📧 Filter Users by Email\n\n**Usage:**\nFilters users by company ID, deleted status, and email addresses.\n\n**Required Input:**\n- `companyId`: Company ID\n- `emails`: Array of email addresses to filter by\n\n**Optional Fields:**\n- `deleted`: Filter by deleted status (true/false)\n\n**Setup:**\n1. Configure HTTP Header Auth with GHL Private Token\n2. Pass companyId and emails array in incoming data\n3. Optionally specify deleted status\n4. Node returns matching users\n\n**Email Array Format:**\n```json\n{\n  \"emails\": [\n    \"user1@example.com\",\n    \"user2@example.com\"\n  ]\n}\n```\n\n**Output:**\nReturns array of users matching the provided email addresses with their current status and details.\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-filter-users-by-email",
      "name": "Sticky Note"
    },
    {
      "parameters": {
        "method": "POST",
        "url": "https://services.leadconnectorhq.com/users/filter",
        "authentication": "genericCredentialType",
        "genericAuthType": "httpHeaderAuth",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Version",
              "value": "2021-07-28"
            },
            {
              "name": "Content-Type",
              "value": "application/json"
            }
          ]
        },
        "sendBody": true,
        "specifyBody": "json",
        "jsonBody": "={\n  \"companyId\": \"{{ $json.companyId }}\",\n  \"emails\": {{ $json.emails ? JSON.stringify($json.emails) : '[]' }},\n  \"deleted\": {{ $json.deleted || false }}\n}",
        "options": {}
      },
      "id": "ghl-filter-users-by-email-001",
      "name": "GHL Filter Users by Email",
      "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": "dd72748b-2bff-481d-833f-1e40cab1cdc3",
    "meta": {
      "name": "API Call Node",
      "id": "api-call",
      "icon": {
        "svg": "",
        "type": "SVG"
      },
      "description": "## 📧 Filter Users by Email  **Usage:**"
    },
    "label": "GHL Filter Users by Email",
    "dependencies": {
      "node-fetch": "3.3.2"
    },
    "script": "import fetch from \"node-fetch\";\nexport default async function apiCall({\n    url,\n    method,\n    contentType,\n    authorization,\n    body,\n    shouldAwait,\n    queryParams,\n    customHeaders\n}: NodeInputs, {\n    logging\n}: NodeScriptOptions) : NodeOutput  {\n    const headers = {\n        \"Content-Type\": contentType,\n        ...customHeaders\n    };\n    if (authorization) headers[\"Authorization\"] = authorization;\n\n    let queryParamsString = '';\n    if (queryParams) {\n        queryParamsString = '?' + new URLSearchParams(queryParams).toString();\n    }\n\n    const fetchOptions = {\n        method,\n        headers\n    };\n\n    if (method !== 'GET') {\n        fetchOptions.body = JSON.stringify(body);\n    }\n\n    const fetchPromise = fetch(url + queryParamsString, fetchOptions);\n\n    if (!shouldAwait) {\n        return {\n            data: null\n        };\n    }\n\n    const response = await fetchPromise;\n    const data = await response.json();\n    return {\n        status: response.status,\n        data\n    };\n}",
    "inputs": {
      "properties": {
        "method": {
          "type": "string",
          "description": "The HTTP method to use for the API call",
          "enum": [
            "GET",
            "POST",
            "PUT",
            "DELETE",
            "PATCH"
          ],
          "default": "POST",
          "title": "HTTP Method",
          "buildship": {
            "options": [
              {
                "label": "GET",
                "value": "GET"
              },
              {
                "value": "POST",
                "label": "POST"
              },
              {
                "value": "PUT",
                "label": "PUT"
              },
              {
                "label": "DELETE",
                "value": "DELETE"
              },
              {
                "label": "PATCH",
                "value": "PATCH"
              }
            ],
            "index": 0,
            "sensitive": false
          }
        },
        "url": {
          "description": "The URL of the API endpoint",
          "title": "URL",
          "type": "string",
          "buildship": {
            "index": 1
          }
        },
        "authorization": {
          "description": "The authorization header for the API call, if required (e.g., Bearer or Basic token)",
          "type": "string",
          "title": "Authorization",
          "buildship": {
            "sensitive": true,
            "index": 2
          }
        },
        "queryParams": {
          "default": {},
          "description": "The query parameters for the API call",
          "type": "object",
          "title": "Query Parameters",
          "buildship": {
            "index": 3,
            "sensitive": false
          }
        },
        "body": {
          "type": "object",
          "buildship": {
            "index": 4
          },
          "description": "The body to send with the API call",
          "title": "Body"
        },
        "contentType": {
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded",
            "multipart/form-data",
            "text/plain"
          ],
          "description": "The content type of the API call",
          "title": "Content Type",
          "buildship": {
            "index": 5,
            "options": [
              {
                "label": "application/json",
                "value": "application/json"
              },
              {
                "value": "application/x-www-form-urlencoded",
                "label": "application/x-www-form-urlencoded"
              },
              {
                "label": "multipart/form-data",
                "value": "multipart/form-data"
              },
              {
                "label": "text/plain",
                "value": "text/plain"
              }
            ]
          },
          "type": "string"
        },
        "shouldAwait": {
          "description": "Whether to wait for the request to complete or not",
          "title": "Await?",
          "type": "boolean",
          "buildship": {
            "sensitive": false,
            "index": 6
          }
        },
        "customHeaders": {
          "type": "object",
          "description": "Additional custom headers for the API call",
          "title": "Custom Headers",
          "buildship": {
            "index": 7,
            "sensitive": false
          }
        }
      },
      "type": "object",
      "required": [
        "url",
        "shouldAwait",
        "method"
      ]
    },
    "integrations": [],
    "name": "API Call Node",
    "output": {
      "buildship": {},
      "properties": {
        "status": {
          "buildship": {
            "index": 0
          },
          "type": "number",
          "description": "The HTTP status of the API response",
          "title": "Status"
        },
        "data": {
          "buildship": {
            "index": 1
          },
          "title": "Data",
          "type": "object",
          "description": "The data object from the API response"
        }
      },
      "type": "object"
    },
    "isCollapsed": false,
    "type": "script",
    "values": {
      "method": "POST",
      "url": "https://services.leadconnectorhq.com/users/filter",
      "authorization": {
        "_$expression_": "`Bearer ${(await getSecret(\"ANONYMIZED_SECRET\"))}`",
        "type": "javascript",
        "hasErrors": false
      },
      "queryParams": {},
      "body": {
        "_$expression_": "{\n  \"companyId\": ctx?.[\"root\"]?.[\"inputs\"]?.[\"body\"].companyId,\n  \"emails\": {{ $json.emails ? JSON.stringify($json.emails) : '[]' }},\n  \"deleted\": {{ $json.deleted || false }}\n}",
        "type": "javascript",
        "hasErrors": false
      },
      "contentType": "application/json",
      "shouldAwait": true,
      "customHeaders": {
        "Version": "2021-07-28",
        "Content-Type": "application/json"
      }
    }
  }
]
{
  "subflows": [
    {
      "flow": [
        {
          "id": 153,
          "module": "http:ActionSendDataBasicAuth",
          "version": 3,
          "parameters": {
            "key": "ANONYMIZED_CREDENTIALS",
            "handleErrors": false,
            "useNewZLibDeCompress": true
          },
          "mapper": {
            "ca": "",
            "qs": [],
            "url": "https://services.leadconnectorhq.com/users/filter",
            "data": "{\n  \"companyId\": {{1.companyId}},\n  \"emails\": {{ $json.emails ? JSON.stringify($json.emails) : '[]' }},\n  \"deleted\": {{ $json.deleted || false }}\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": "Filter Users by Email"
            },
            "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
  }
}

🔗 Related GoHighLevel Nodes

▶️ Activate Invoice Schedule
Activates a schedule to start sending invoices to the customer.
📧 Add Contact to Campaign
Adds a contact to a specific marketing campaign.
🔄 Add Contact to Workflow
Adds a contact to a specific workflow/automation.
👥 Add Followers to Contact
Adds one or more followers to a contact for notifications and collaboration.
📥 Add Inbound Message
Adds an external inbound message to a conversation. Requires conversationId or contactId.
📞 Add Outbound Call
Adds an external outbound call record to track phone communications.
← Browse all nodes