List leads
list_leadsRead-onlyIdempotent
This workspace's leads with LinkedIn and sequence progress. stage is cumulative (reached this milestone or beyond); stageExact is the current position only. Count is exact even when the page is limited. Pass leadId to read one lead in full. To undo a removal whose ID was not saved, search with query without activity/stage filters, identify the correct person and sequence, then pass their removal.id to undo_remove_leads. removal is null when no current Undo event is available; do not add a replacement lead. A returned ID still requires Undo's normal safety checks. Returns count, returned and leads, or lead with leadId.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_leads"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Zero-based page for personalFiles. | |
| limit | No | Most leads to return in this page, most recent activity first; count stays exact. Omit for 100. | |
| query | No | Text matched against the person's name, email, company and title; with personalFiles it also matches handles. | |
| stage | No | Leads that reached this milestone or went further, for example accepted also returns messaged and replied people. Omit for every stage. | |
| leadId | No | Read just this one lead in full (from an earlier list_leads, add_leads or reply). Other filters are ignored. | |
| sinceDays | No | Only people who replied or booked a meeting within this many days. Omit or 0 for no time window. | |
| bookedOnly | No | Only people with a booked meeting. | |
| sequenceId | No | Only leads in this sequence, from list_sequences. Required with personalFiles. | |
| stageExact | No | Leads whose current position is exactly this stage. Use it for waiting rooms (queued, resolving) and exits (failed, skipped). | |
| strategyId | No | Only leads that came from this Play, by its ID from get_workspace or find_people. | |
| engagedOnly | No | Only people who replied or booked a meeting. | |
| workspaceId | No | A teammate's workspace you may manage: an active workspace ID from list_team_workspaces. Omit for your own workspace. Supply on every call for a teammate. | |
| personalFiles | No | With sequenceId: which file each person has for that sequence's per-person file step (for example their personalised video), 25 people a page: file name and size, and state waiting (no file yet), ready (attached, not sent), sent, or closed (not needed). query narrows by name, email, company or handle; waitingForInput=true lists only people still missing a file. Use it when the customer wants to check who got which file; appUrl opens the same table in the app, where each video can be watched. | |
| waitingForInput | No | Only people the engine is holding because a LinkedIn message, email, X DM or Instagram DM step needs a value from the customer (see leads_waiting_for_input in get_workspace). Each returned lead lists channel, waitingFor keys (waitingForFiles names the ones that are a file for that person) and waitingSince. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | With personalFiles: the file slot's key, used with set_lead_input. | |
| lead | No | With leadId: that one lead in full. | |
| page | No | With personalFiles: the zero-based page returned. | |
| count | No | Exact number of leads matching the filters, even when the page is limited. | |
| leads | No | The matching leads (stage, milestone dates, sequenceId, sender account, removal with its Undo ID or null), or with waitingForInput the held people with channel, waitingFor keys and waitingSince. | |
| total | No | With waitingForInput or personalFiles: everyone matching, across all pages. | |
| appUrl | No | With personalFiles: link to the same table in the app, where each file can be opened. | |
| people | No | With personalFiles: each person with their file (name and size, or null) and state. | |
| hasMore | No | With waitingForInput or personalFiles: whether more people exist beyond this page. | |
| channels | No | With personalFiles: the channels whose steps send this file. | |
| pageSize | No | With personalFiles: people per page. | |
| returned | No | How many leads or waiting people are in this page. | |
| sequenceId | No | With personalFiles: the sequence listed. | |
| sequenceName | No | With personalFiles: that sequence's name. | |
| waitingTotal | No | With personalFiles: how many people still have no file. |