GET api/people/findbyemail?emailAddress={emailAddress}
Returns a list of people that have the supplied email address. Processes this people API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| emailAddress |
The email address. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of people with the specified email address.
Collection of PersonDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Gender |
The gender value. |
EnumDataContract |
None. |
| Title |
The title value. |
string |
None. |
| FirstName |
The first name value. |
string |
None. |
| LastName |
The last name value. |
string |
None. |
| Note |
The note value. |
string |
None. |
| ContactName |
The contact name value. |
string |
None. |
| PrimaryTelephone |
The primary telephone value. |
ContactItemDataContract |
None. |
| PrimaryEmail |
The primary email value. |
ContactItemDataContract |
None. |
| GroupCount |
The group count value. |
integer |
None. |
| GroupMemberships |
The collection of group memberships. |
Collection of GroupMembershipDataContract |
None. |
| ContactItems |
The collection of contact items. |
Collection of ContactItemDataContract |
None. |
| Addresses |
The collection of addresses. |
Collection of ContactAddressDataContract |
None. |
| ArchivedAddresses |
The collection of archived addresses. |
Collection of ContactAddressDataContract |
None. |
| AdditionalInformation |
The additional information value. |
AdditionalInformationDataContract |
None. |
| MarketingPreferences |
The collection of marketing preferences. |
Collection of MarketingPreferenceDataContract |
None. |
| GroupIds |
The unique identifiers of the related group resources. |
Collection of integer |
None. |
| HasBankAccounts |
Indicates whether this item has bank accounts. |
boolean |
None. |
| CustomFields |
The collection of custom fields. |
Collection of CustomFieldGroupWithValuesDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.