Lookup the contact list(Basic information) Post

The API provides feature to get the list of contact with basic information, to extent the information like relationship, phones, email use the admin/contact/search API.

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

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
}

Lookup the contact

In order to get the lookup contacts, find the below sample:

{
  "PageNo": 1,
  "PageSize": 100,
  "Criteria": {
    "ContactGroupType": 1,
    "Phrase": "String Parameter 1"
  }
}

Response Information

Resource Description

ITypedResponse with list of Contacts (Individual+Organization) that match the specified search filter be wrapped inside.

Response Formats