`freshdesk_list_contacts`

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

List customer contacts. Returns name, email, phone, company, and contact ID for filtering and pagination.

Parameters

Name	Type	Required	Description
`_apiKey`	string	yes	Freshdesk API key
`_domain`	string	yes	Freshdesk subdomain
`page`	number	no	Page number for pagination (default 1)
`per_page`	number	no	Results per page (default 30, max 100)

Example call

Arguments

{
  "_apiKey": "your-freshdesk-api-key",
  "_domain": "mycompany"
}

curl

curl -X POST https://gateway.pipeworx.io/freshdesk/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"freshdesk_list_contacts","arguments":{"_apiKey":"your-freshdesk-api-key","_domain":"mycompany"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('freshdesk_list_contacts', {
  "_apiKey": "your-freshdesk-api-key",
  "_domain": "mycompany"
});

More examples

{
  "_apiKey": "your-freshdesk-api-key",
  "_domain": "mycompany",
  "page": 1,
  "per_page": 50
}

Response shape

Field	Type	Description
`contacts`	array	Array of contact objects

Full JSON Schema

{
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "description": "Array of contact objects",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Contact ID"
          },
          "name": {
            "type": "string",
            "description": "Contact name"
          },
          "email": {
            "type": "string",
            "description": "Contact email address"
          },
          "phone": {
            "type": [
              "string",
              "null"
            ],
            "description": "Contact phone number"
          },
          "company_id": {
            "type": [
              "number",
              "null"
            ],
            "description": "Associated company ID"
          },
          "created_at": {
            "type": "string",
            "description": "ISO timestamp"
          }
        }
      }
    }
  }
}

Connect

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

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

See Getting Started for client-specific install steps.

freshdesk_list_contacts