Home / API Documentation

Get Contacts by PhoneNumber

Method: GET api/v1/Account/GetContactsByPhoneNumber?phoneNumber={phoneNumber}

Response Format:

application/json

Required Parameters Description Additional information
phoneNumber
Phone Number

Define this parameter in the request URI.

application/json, text/json

Sample Response:
                        [
  {
    "contactid": 1,
    "companyid": 2,
    "contacttype": 64,
    "firstname": "sample string 4",
    "middlename": "sample string 5",
    "lastname": "sample string 6",
    "emailaddress": "sample string 7",
    "webaddress": "sample string 8",
    "primaryphoneid": 9,
    "utctimestamp": "2025-02-23T06:31:07.4639101+00:00",
    "utclastchanged": "2025-02-23T06:31:07.4639101+00:00",
    "lastchangedby": "sample string 10",
    "businessname": "sample string 11",
    "contactdescription": "sample string 12",
    "altphoneid1": 13,
    "altphoneid2": 14,
    "salutation": "sample string 15",
    "accountid": 16,
    "contactphonenumber": {
      "phoneid": 1,
      "contactid": 2,
      "phonetype": 64,
      "phonenumber": "sample string 4",
      "phoneextension": "sample string 5",
      "phonenote": "sample string 6",
      "phonenumbersearch": "sample string 7",
      "utctimestamp": "2025-02-23T06:31:07.4639101+00:00",
      "utclastchanged": "2025-02-23T06:31:07.4639101+00:00",
      "lastchangedby": "sample string 8"
    }
  },
  {
    "contactid": 1,
    "companyid": 2,
    "contacttype": 64,
    "firstname": "sample string 4",
    "middlename": "sample string 5",
    "lastname": "sample string 6",
    "emailaddress": "sample string 7",
    "webaddress": "sample string 8",
    "primaryphoneid": 9,
    "utctimestamp": "2025-02-23T06:31:07.4639101+00:00",
    "utclastchanged": "2025-02-23T06:31:07.4639101+00:00",
    "lastchangedby": "sample string 10",
    "businessname": "sample string 11",
    "contactdescription": "sample string 12",
    "altphoneid1": 13,
    "altphoneid2": 14,
    "salutation": "sample string 15",
    "accountid": 16,
    "contactphonenumber": {
      "phoneid": 1,
      "contactid": 2,
      "phonetype": 64,
      "phonenumber": "sample string 4",
      "phoneextension": "sample string 5",
      "phonenote": "sample string 6",
      "phonenumbersearch": "sample string 7",
      "utctimestamp": "2025-02-23T06:31:07.4639101+00:00",
      "utclastchanged": "2025-02-23T06:31:07.4639101+00:00",
      "lastchangedby": "sample string 8"
    }
  }
];