list_leads
List the leads (CRM records) of the current team — one lead per respondent across all forms, carrying follow-up status, assignee, colour tags, submission count and the next upcoming booking. Newest activity first by default. Filter by status / assignee / tags / created-at range / keyword / whether they have an upcoming booking. Status codes and tag codes are team-defined — call list_lead_settings first to get the valid ones, never guess. Reference a lead by its leadId and a respondent by examineeId, never by a masked email.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-based), default 1 | |
| sort | No | Sort order, default -lastRecordAt (most recent submission first) | |
| limit | No | Items per page, default 20, max 100 | |
| status | No | Filter by follow-up status code (see list_lead_settings), optional | |
| keyword | No | Fuzzy match on the respondent's name or email. Matching runs server-side against the real values, so you can search by a full or partial email even though results come back masked. | |
| tagCodes | No | Filter by colour tag codes; a lead matches if it has ANY of them (OR). Optional. | |
| createdTo | No | Only leads created strictly before this ISO datetime (half-open), optional | |
| assigneeId | No | Filter by the assigned member userId (see list_lead_settings.assignableMembers). Pass "me" for the current token's own user. Optional. | |
| createdFrom | No | Only leads created on/after this ISO datetime, optional | |
| hasUpcomingBooking | No | true = only leads with an active upcoming booking, false = only those without. Omit to not filter. Note: this filters within the page, so counts stay on the unfiltered basis. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page returned | |
| items | No | The page of leads, PII masked | |
| totalDocs | No | Total leads matching the filter | |
| totalPages | No | Total pages available | |
| hasNextPage | No | Whether another page follows |