Searching contacts having email address defined Post

The API provides feature to search contact having email address defined including relationships, phones, emails, benefits etc, in order to search contacts, we need to pass the contact group type like organization or individual along with include options in search criteria.

Request Information

Body Parameters

Body parameters need to be integrated as json key value collection followed by valid object notations, below if the list of parameters can be sent as request body by an integrator.

Basic Search Criteria Query(Ignores the paging parameters)

Request Format

Below is the typical object of the request, in order to use the API for various requirement, refer the documentation.

{
  "PageNo": 1,
  "PageSize": 2,
  "TotalRecords": 3,
  "Criteria": {
    "Phrase": "String Parameter 1",
    "ContactGroupType": 0,
    "CountOnly": true,
    "IncludeMembership": true,
    "IncludeRaltionship": true,
    "IncludeBenefitsToAvail": true,
    "IncludeDonationInformation": true
  },
  "ActiveRecords": 4,
  "InActiveRecords": 5
}

Querying contact list

Below is the sample finds individual contact with relationship list:

{
  "PageNo": 1,
  "PageSize": 100,
  "Criteria": {
    "Phrase":"",
    "ContactGroupType": 1,
    "IncludeMembership": true,
    "IncludeRaltionship": true,
    "IncludeBenefitsToAvail": true,
    "IncludeDonationInformation": true
  }
}

Response Information

Resource Description

ITypedResponse with list of ContactWithEmail be wrapped inside.

Response Formats