Search by Partial Information

This call is executed to search for the customers associated with a program. The customer list is obtained based on the set search criteria.

GET
/accounts/search

Request elements

Parameter Type Required Description
first String No First name of the customer
last String No Last name of the customer
phone String No Phone number of the customer
email String No Email ID of the customer
employeeId String No Employee ID of the customer
businessFieldsRequired String Yes Value required in the response
page Integer Yes Search page number
size Integer Yes Number of records to return by page

Error messages

Error Code Error Message
400 Bad request
401 Not authorized
500 Internal server error

 

EXAMPLE REQUEST:

GET http://[subdomain].datanuum.com/accounts/search?   first=Jenn&last=C&businessFieldsRequired=title,street1&page=1&size=10


EXAMPLE RESPONSE:

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalCount": 7,
  "data": [
    {
      "phone": "971502188801",
      "email": "jane@gmail.com",
      "accountId": "2a5676fe-0151-435f-b392-131ab2eae0c5",
      "first": "Jennifer",
      "last": "Christi",
      "birthdate": "1987-09-11",
      "profileSet": "2018-03-26 12:44:55 GST",
      "businessFields": {
        "title": "Mr."
    },    
    {
      "phone": "971502188844",
      "email": "jen124@gmail.com",
      "accountId": "e4670b54-4d13-40c3-a49a-64d225231152",
      "first": "Jennie",
      "last": "Cooks",
      "birthdate": "1987-09-11",
      "profileSet": "2018-03-28 06:56:03 GST",
      "businessFields": {
        "street1": "M street"
      }
    }
  ]
}