Get verified email addresses and phone numbers for people.
const contacts = await canvas.contacts.enrich({
people,
});
// Each person now has email
contacts.forEach(c => canvas.log(`${c.name}: ${c.email}`));
emailType: "personal" when you want personal emails prioritized.
const contacts = await canvas.contacts.enrich({
people,
emailType: "personal",
});
Parameters
People to enrich. Usually the output of canvas.people.search().
Include email enrichment.
Include phone enrichment. Set to true to also get phone numbers.
emailType
"any" | "work" | "personal"
default:"\"any\""
Email preference for enrichment.
personal prioritizes personal emails and keeps backward compatibility by still populating email.
Returns
The same people array with additional contact fields:
| Field | Type | Description |
|---|
email | string | Canonical email field for backward compatibility |
personal_email | string | Personal email when available |
work_email | string | Work email when available |
email_type | "personal" | "work" | "other" | "unknown" | "generic" | Provider email classification |
email_status | string | Provider validation status (for example: valid, risky, unknown) |
phone | string | Phone number (if available) |
Examples
Email only (default)
const contacts = await canvas.contacts.enrich({
people,
});
// Returns people with email addresses
Personal email mode
const contacts = await canvas.contacts.enrich({
people,
emailType: "personal",
});
email is still populated for backward compatibility, and personal_email is preserved explicitly.
Personal email mode with strict quality filter
const contacts = await canvas.contacts.enrich({
people,
emailType: "personal",
});
const validPersonalOnly = contacts.filter(
(c) => c.personal_email && c.email_status === "valid",
);
Email + Phone
const contacts = await canvas.contacts.enrich({
people,
phone: true,
});
// Returns people with both email and phone
Phone only
const contacts = await canvas.contacts.enrich({
people,
email: false,
phone: true,
});
// Returns people with phone numbers only
