Actions

Call the findLeads MCP tool

Find specific leads in the workspace: by name or LinkedIn URL (query), by lead list (list_id from getLeadLists), by status, by tag, or by outreach_status (replied | booked | contacted | closed). Returns per-lead identity, status, tags and notes, paginated with a total. Result order is not part of the contract and varies by filter mode; page with offset/limit for full coverage. For aggregate counts use getLeadStats. To edit a lead found here, pass its lead_id to updateLead.

Called through the Actions bridge: the response is that tool's own result, wrapped as { data: <tool result> } under HTTP 200. Billing, daily-cap, and confirm-step outcomes are embedded INSIDE data, never remapped to an HTTP status (see the templated /api/v1/actions/{toolName} operation above for the full protocol, and x-mcp-actions for this tool's machine-readable scope/cap/confirm_behavior fields). Authentication, request-shape, and optional idempotency-protocol failures still use their documented non-200 statuses.

post/api/v1/actions/findLeads

Request

  • Base URL: https://app.reachium.io
  • URL: https://app.reachium.io/api/v1/actions/findLeads
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional caller-generated key (8-200 characters: letters, digits, dot, underscore, colon, or hyphen). A final tool result is replayed for the same key and body. An ambiguous result remains 409 under that key; reconcile external state before using a new key. Reuse with a different body returns 422.

Request body

querystring

Name fragment, full name ("John Smith": words match across name fields in any order), or LinkedIn URL fragment.

list_idstring uuid

Restrict to one lead list (id from getLeadLists).

status'new' | 'active' | 'contacted' | 'qualified' | 'lost' | 'unsubscribed'
outreach_status'booked' | 'replied' | 'closed' | 'contacted'

replied = lead answered; booked = meeting booked.

tag'positive_reply' | 'not_a_fit' | 'booked_in' | 'no_engagement' | 'off_platform_activity' | 'follow_up_later' | 'do_not_contact' | 'customer'
limitinteger

Rows per page (default 20, max 100).

offsetinteger

Response

The result of calling this tool.

dataunknown required
errorunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.