ashby_list_candidates

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

Search candidates in your ATS. Returns names, emails, and application metadata. Use ashby_get_candidate with ID for full profile details.

Parameters

NameTypeRequiredDescription
_apiKeystringyesAshby API key
cursorstringnoPagination cursor from a previous response
per_pagenumbernoNumber of candidates per page (default 50)

Example call

Arguments

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

curl

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

TypeScript (@pipeworx/sdk)

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

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

More examples

{
  "_apiKey": "your-ashby-api-key",
  "per_page": 25
}

Response shape

FieldTypeDescription
resultsarrayList of candidate records
nextCursorstringPagination cursor for next page
Full JSON Schema
{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "description": "List of candidate records",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Candidate ID"
          },
          "name": {
            "type": "string",
            "description": "Candidate full name"
          },
          "email": {
            "type": "string",
            "description": "Candidate email address"
          }
        }
      }
    },
    "nextCursor": {
      "type": "string",
      "description": "Pagination cursor for next page"
    }
  }
}

Connect

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

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

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026