Find a supporter
find_supporterLook up a supporter by email or ID to get their ID, name, suppression status, and optional answers or memberships. Contact details are included only if requested.
Instructions
Look up one supporter by email address or by supporter ID. Returns the supporter ID, whether they are suppressed (excluded from email), their name, and optionally their question and opt-in answers and memberships. The email, phone, postal address, date of birth and every other supporter field are only returned with include_contact_details; card and bank fields are never returned. Emails, phone numbers and postcodes typed into names and answers are redacted by pattern unless include_contact_details is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | The supporter's email address | ||
| supporter_id | No | Supporter ID (numeric) | |
| include_questions | No | Include question and opt-in answers (the API's includeQuestions) | |
| include_memberships | No | Include memberships (the API's includeMemberships) | |
| include_contact_details | No | Include every supporter field (email, phone, address, date of birth, custom fields) and stop redacting contact details from names and free-text answers |