EpicInstall

Summary

Retrieve a list of contacts from the Epic system filtered by various criteria such as individual or business type, names, dates of birth, email, phone number, classification, and more.

Inputs

• Accept Language — Specify the language locale for returned descriptions, e.g. 'en-US'.
• Limit — Maximum number of contact records to retrieve.
• Offset — Record position to start pulling contacts from.
• Embed — Embed specified sub-resources within the contact results.
• Individual Or Business — Filter contacts by type: INDIVIDUAL or BUSINESS.
• Is Primary — Filter to only primary contacts if true.
• Is Category Contact — Filter contacts by Contact category type if true.
• Is Category Policy — Filter contacts by Policy category type if true.
• First Name — Filter individual contacts with exact matching first name.
• First Name Contains — Filter individual contacts whose first name contains the given text.
• Last Name — Filter individual contacts with exact matching last name.
• Last Name Contains — Filter individual contacts whose last name contains the given text.
• Date Of Birth — Filter individual contacts with exact matching date of birth.
• Date Of Birth Before — Filter individual contacts born before the specified date.
• Date Of Birth After — Filter individual contacts born after the specified date.
• Name — Filter business contacts by exact matching full name.
• Name Contains — Filter business contacts whose full name contains the given text.
• Is Main Business — Filter business contacts marked as main business contact if true.
• Sic — Filter business contacts by SIC code.
• Naics — Filter business contacts by NAICS code.
• Phone Number — Filter contacts by exact matching phone number.
• Phone Number Contains — Filter contacts whose phone number contains specified text.
• Address Contains — Filter contacts whose address contains specified text.
• Email — Filter contacts by exact matching email address.
• Email Contains — Filter contacts whose email address contains specified text.
• Classification — Filter contacts by contact classification.
• Person — Filter contacts with matching person.
• Account — Filter contacts by matching account.
• Last Updated Date Before — Filter contacts updated before a specified date.
• Last Updated Date After — Filter contacts updated after a specified date.

Output shape

a list of contact records matching the specified filters

Supports pagination via Limit and Offset parameters. Returned contacts may include embedded sub-resources if specified. Errors are returned as standard API error objects.