Candidates

get_candidates

Get list of candidates for the authenticated user's organization

get_candidates

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidates",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ],
        "status": "APPLIED",
        "organizationPositionId": "550e8400-e29b-41d4-a716-446655440000",
        "sourceId": "550e8400-e29b-41d4-a716-446655440000",
        "rating": 0
      }
  }
}

const result = await client.callTool({
  "name": "get_candidates",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ],
    "status": "APPLIED",
    "organizationPositionId": "550e8400-e29b-41d4-a716-446655440000",
    "sourceId": "550e8400-e29b-41d4-a716-446655440000",
    "rating": 0
  }
});

result = await session.call_tool("get_candidates", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ],
  "status": "APPLIED",
  "organizationPositionId": "550e8400-e29b-41d4-a716-446655440000",
  "sourceId": "550e8400-e29b-41d4-a716-446655440000",
  "rating": 0
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for candidate name or email

relationsArray<string>

Relations to include (e.g., ["user", "contact", "organizationPosition", "skills", "experience"])

statusstringAPPLIEDREJECTEDHIREDINTERVIEWON_HOLD

Filter by candidate status

organizationPositionIdstring<uuid>

Filter by organization position ID

sourceIdstring<uuid>

Filter by candidate source ID

ratingnumber[0, 5]

Filter by minimum rating

get_candidate_count

Get candidate count in the authenticated user's organization

get_candidate_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidate_count",
    "arguments": {
        "status": "APPLIED",
        "organizationPositionId": "550e8400-e29b-41d4-a716-446655440000",
        "sourceId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_candidate_count",
  "arguments": {
    "status": "APPLIED",
    "organizationPositionId": "550e8400-e29b-41d4-a716-446655440000",
    "sourceId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_candidate_count", arguments={
  "status": "APPLIED",
  "organizationPositionId": "550e8400-e29b-41d4-a716-446655440000",
  "sourceId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

statusstringAPPLIEDREJECTEDHIREDINTERVIEWON_HOLD

Filter by candidate status

organizationPositionIdstring<uuid>

Filter by organization position ID

sourceIdstring<uuid>

Filter by candidate source ID

get_candidate

Get a specific candidate by ID

get_candidate

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidate",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_candidate",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_candidate", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The candidate ID

relationsArray<string>

Relations to include (e.g., ["user", "contact", "skills", "experience", "education", "documents"])

create_candidate

Create a new candidate in the authenticated user's organization

create_candidate

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_candidate",
    "arguments": {
        "candidate_data": {
          "userId": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_candidate",
  "arguments": {
    "candidate_data": {
      "userId": "string"
    }
  }
});

result = await session.call_tool("create_candidate", arguments={
  "candidate_data": {
    "userId": "string"
  }
})

Request Body

{
  "candidate_data": {
    "userId": "string"
  }
}

Body

application/json

candidate_dataobjectrequired

The data for creating the candidate

Show child attributes

userIdstringrequired

The userId (required)

[key: string]any

update_candidate

Update an existing candidate

update_candidate

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_candidate",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "candidate_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_candidate",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "candidate_data": {}
  }
});

result = await session.call_tool("update_candidate", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "candidate_data": {}
})

Parameters

idstring<uuid>required

The candidate ID

candidate_dataobjectrequired

The data for updating the candidate

update_candidate_status

Update the status of a candidate

update_candidate_status

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_candidate_status",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "status": "APPLIED"
      }
  }
}

const result = await client.callTool({
  "name": "update_candidate_status",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "APPLIED"
  }
});

result = await session.call_tool("update_candidate_status", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "APPLIED"
})

Parameters

idstring<uuid>required

The candidate ID

statusstringAPPLIEDREJECTEDHIREDINTERVIEWON_HOLDrequired

The new status for the candidate

rate_candidate

Rate a candidate

rate_candidate

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "rate_candidate",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "rating": 0
      }
  }
}

const result = await client.callTool({
  "name": "rate_candidate",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "rating": 0
  }
});

result = await session.call_tool("rate_candidate", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "rating": 0
})

Parameters

idstring<uuid>required

The candidate ID

ratingnumber[0, 5]required

The rating (0-5)

delete_candidate

Delete a candidate

delete_candidate

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_candidate",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_candidate",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_candidate", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The candidate ID

get_candidates_by_position

Get candidates for a specific organization position

get_candidates_by_position

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidates_by_position",
    "arguments": {
        "positionId": "550e8400-e29b-41d4-a716-446655440000",
        "page": 1,
        "limit": 10,
        "status": "APPLIED",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_candidates_by_position",
  "arguments": {
    "positionId": "550e8400-e29b-41d4-a716-446655440000",
    "page": 1,
    "limit": 10,
    "status": "APPLIED",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_candidates_by_position", arguments={
  "positionId": "550e8400-e29b-41d4-a716-446655440000",
  "page": 1,
  "limit": 10,
  "status": "APPLIED",
  "relations": [
    "string"
  ]
})

Parameters

positionIdstring<uuid>required

The organization position ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

statusstringAPPLIEDREJECTEDHIREDINTERVIEWON_HOLD

Filter by candidate status

relationsArray<string>

Relations to include

get_candidate_skills

Get skills for a specific candidate

get_candidate_skills

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidate_skills",
    "arguments": {
        "candidateId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_candidate_skills",
  "arguments": {
    "candidateId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_candidate_skills", arguments={
  "candidateId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

candidateIdstring<uuid>required

The candidate ID

add_candidate_skill

Add a skill to a candidate

add_candidate_skill

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_candidate_skill",
    "arguments": {
        "candidateId": "550e8400-e29b-41d4-a716-446655440000",
        "skill": {
          "name": "string",
          "proficiency": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "add_candidate_skill",
  "arguments": {
    "candidateId": "550e8400-e29b-41d4-a716-446655440000",
    "skill": {
      "name": "string",
      "proficiency": "string"
    }
  }
});

result = await session.call_tool("add_candidate_skill", arguments={
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "skill": {
    "name": "string",
    "proficiency": "string"
  }
})

Request Body

{
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "skill": {
    "name": "string",
    "proficiency": "string"
  }
}

Body

application/json

candidateIdstring<uuid>required

The candidate ID

skillobjectrequired

The skill to add

Show child attributes

namestringrequired

Skill name

proficiencystring

Proficiency level (e.g., "Beginner", "Intermediate", "Advanced", "Expert")

get_candidate_experience

Get experience for a specific candidate

get_candidate_experience

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidate_experience",
    "arguments": {
        "candidateId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_candidate_experience",
  "arguments": {
    "candidateId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_candidate_experience", arguments={
  "candidateId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

candidateIdstring<uuid>required

The candidate ID

add_candidate_experience

Add work experience to a candidate

add_candidate_experience

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_candidate_experience",
    "arguments": {
        "candidateId": "550e8400-e29b-41d4-a716-446655440000",
        "experience": {
          "occupation": "string",
          "organization": "string",
          "duration": "string",
          "description": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "add_candidate_experience",
  "arguments": {
    "candidateId": "550e8400-e29b-41d4-a716-446655440000",
    "experience": {
      "occupation": "string",
      "organization": "string",
      "duration": "string",
      "description": "string"
    }
  }
});

result = await session.call_tool("add_candidate_experience", arguments={
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "experience": {
    "occupation": "string",
    "organization": "string",
    "duration": "string",
    "description": "string"
  }
})

Request Body

{
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "experience": {
    "occupation": "string",
    "organization": "string",
    "duration": "string",
    "description": "string"
  }
}

Body

application/json

candidateIdstring<uuid>required

The candidate ID

experienceobjectrequired

The experience to add

Show child attributes

occupationstringrequired

Job title/occupation

organizationstringrequired

Company/organization name

durationstringrequired

Duration of employment (e.g., "2 years", "Jan 2020 - Dec 2022")

descriptionstring

Description of responsibilities and achievements

get_candidate_education

Get education for a specific candidate

get_candidate_education

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidate_education",
    "arguments": {
        "candidateId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_candidate_education",
  "arguments": {
    "candidateId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_candidate_education", arguments={
  "candidateId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

candidateIdstring<uuid>required

The candidate ID

add_candidate_education

Add education to a candidate

add_candidate_education

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_candidate_education",
    "arguments": {
        "candidateId": "550e8400-e29b-41d4-a716-446655440000",
        "education": {
          "schoolName": "string",
          "degree": "string",
          "field": "string",
          "completionDate": "string",
          "notes": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "add_candidate_education",
  "arguments": {
    "candidateId": "550e8400-e29b-41d4-a716-446655440000",
    "education": {
      "schoolName": "string",
      "degree": "string",
      "field": "string",
      "completionDate": "string",
      "notes": "string"
    }
  }
});

result = await session.call_tool("add_candidate_education", arguments={
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "education": {
    "schoolName": "string",
    "degree": "string",
    "field": "string",
    "completionDate": "string",
    "notes": "string"
  }
})

Request Body

{
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "education": {
    "schoolName": "string",
    "degree": "string",
    "field": "string",
    "completionDate": "string",
    "notes": "string"
  }
}

Body

application/json

candidateIdstring<uuid>required

The candidate ID

educationobjectrequired

The education to add

Show child attributes

schoolNamestringrequired

School/university name

degreestringrequired

Degree obtained

fieldstringrequired

Field of study

completionDatestring

Completion date (ISO format)

notesstring

Additional notes about the education

Stack Overflow Website Demo