`leadconnector_list_contacts`

Pack: leadconnector · Endpoint: https://gateway.pipeworx.io/leadconnector/mcp

Search or list CRM contacts in a GoHighLevel/LeadConnector account. Free-text query matches name, email, or phone. Returns a {contacts:[…], meta} envelope with contact IDs, names, emails, phones, tags, and custom fields. Requires your own GoHighLevel token via _apiKey (plus locationId for a v2 pit- token).

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Your own GoHighLevel/LeadConnector token (BYO — Pipeworx does not supply one). Either a v2 Private Integration Token (`pit-` prefixed; Settings → Private Integrations) — pass `locationId` with it — or a legacy v1 Location API key (Settings → Business Profile → API Key). GoHighLevel has retired v1 key creation, so new accounts will have a v2 token.
`locationId`	string	no	GoHighLevel sub-account (Location) ID. REQUIRED with a v2 `pit-` token, ignored for a v1 key. It is the id in the dashboard URL: …/location//…
`query`	string	no	Free-text search across contact name, email, and phone
`limit`	number	no	Max contacts to return (default 20, max 100)

Example call

Arguments

{
  "_apiKey": "pit-your-private-integration-token",
  "locationId": "ve9EPM428h8vShlRW1KT"
}

curl

curl -X POST https://gateway.pipeworx.io/leadconnector/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"leadconnector_list_contacts","arguments":{"_apiKey":"pit-your-private-integration-token","locationId":"ve9EPM428h8vShlRW1KT"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('leadconnector_list_contacts', {
  "_apiKey": "pit-your-private-integration-token",
  "locationId": "ve9EPM428h8vShlRW1KT"
});

More examples

{
  "_apiKey": "pit-your-private-integration-token",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "query": "John Smith",
  "limit": 50
}

{
  "_apiKey": "your-legacy-v1-location-api-key"
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "leadconnector": {
      "url": "https://gateway.pipeworx.io/leadconnector/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

leadconnector_list_contacts