greenhouse_list_candidates

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

Search candidates in your ATS. Returns names, IDs, email addresses, and application status. Use greenhouse_get_candidate for full profile details.

Parameters

NameTypeRequiredDescription
_apiKeystringyesGreenhouse Harvest API key
per_pagenumbernoResults per page (max 500, default 50)
pagenumbernoPage number (default 1)

Example call

Arguments

{
  "_apiKey": "your-greenhouse-api-key"
}

curl

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

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('greenhouse_list_candidates', {
  "_apiKey": "your-greenhouse-api-key"
});

More examples

{
  "_apiKey": "your-greenhouse-api-key",
  "per_page": 100,
  "page": 2
}

Response shape

Always returns: items, count

FieldTypeDescription
itemsarrayList of candidates with basic profile information
countintegerNumber of items returned.
Full JSON Schema
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "List of candidates with basic profile information",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "Candidate ID"
          },
          "first_name": {
            "type": "string",
            "description": "Candidate first name"
          },
          "last_name": {
            "type": "string",
            "description": "Candidate last name"
          },
          "email": {
            "type": "string",
            "description": "Candidate email address"
          },
          "status": {
            "type": "string",
            "description": "Application status"
          }
        }
      }
    },
    "count": {
      "type": "integer",
      "description": "Number of items returned."
    }
  },
  "required": [
    "items",
    "count"
  ]
}

Connect

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

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

See Getting Started for client-specific install steps.

Regenerated from source · build June 24, 2026