Find People
find_peopleWho among your guests/members … (read-only): rules in the email studio's condition format, with eventIds + scope any|sum and since/until dates, plus exclude_rules. mode count (first), sample (≤5 first names) or top (by net_spend, events_attended, tickets, last_attended; limit ≤50). Returns matched (everyone, not only emailable), reachable by email/sms/app with excluded-by-reason counts, plainRule (say it), coverage notes and exact. No emails or phones in rows. Your own network, or scope.community_id for a community you run.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | count first; sample = up to 5 first names; top = the top `limit` by top_by. | |
| limit | No | ||
| rules | Yes | Who to include. Empty = everyone in your network. | |
| scope | No | A community you administer, instead of your own network. | |
| cursor | No | nextCursor from a previous result whose exact was false. | |
| top_by | No | ||
| currency | No | For net_spend ranking (default USD). | |
| exclude_rules | No | Leave out anyone matching these (e.g. came to the October dinners). |