ToolsCandidates
Candidates
Generated from the Rover tool catalog. Do not edit by hand.
| Tool | Access | Description |
|---|---|---|
| [[searchCandidates]] | Read | Live candidate search (max 5 results). Use for quick name/email lookup or autocomplete. Pass excludePositionId to skip people already on a position. For larger result sets or location, workflow, referrer, and channel filters, use list-candidates. |
| [[listCandidates]] | Read | Paginated candidate list with contact fields and tags. Use when the user names a position, hiring stage, company, tag, location, workflow, referrer, or channel. Pass those filters on the first call. excludePositionId drops people already submitted to that position. Default limit is 10. Do not page an unfiltered catalog and filter in the reply. |
| [[getCandidate]] | Read | Get one candidate by id with tags and related submissions/positions. |
| [[listCandidateEvents]] | Read | Paginated Activity tab for one candidate: notes, files, email/SMS, meetings, profile, tags, submissions, availability. Prefer category over type. |
| [[listCalendarEvents]] | Read | List the signed-in user's connected Google or Outlook calendar events. Optional startDate/endDate (ISO). Omit both for SaaS default (start of today through 30 days). Do not pass hostId. If connected is false, explain that a calendar must be connected and share connectUrl — do not retry this tool. Title Unavailable is a private external block. Distinct from listCandidateEvents (Activity tab). |
| [[createCandidate]] | Write | Create a candidate in Leadline. Requires first and last name plus email or phone. Also creates a default Applied submission. |
| [[sendEmail]] | Write | Send one shared email to 1–50 candidates. Put every recipient in candidates[]; same subject and message for all. Personalize with literal {{Candidate Name}} — never paste a real name or split the same copy into one call per candidate. Copy snapshots from get/list/search in this run. Requires approval when enabled. |
| [[createMeeting]] | Write | Schedule one meeting with exactly one candidate. Keep SmartLines literal (Hi {{Candidate Name}}, {{Meeting Host Link}}); never paste the candidate first name. Pass a snapshot copied from get/list/search. Default is virtual with a booking link. Omit meetingLink so SaaS generates one. Requires approval when enabled. |