Home / API / ASP.NET Web API Details

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

Description

Get Contacts by PhoneNumber

Request Information

Parameters

NameDescriptionAdditional information
phoneNumber
Phone Number

Define this parameter in the request URI.

Response Information

Contacts Information

Response body formats

application/json, text/json

Sample:
[
  {
    "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:28:17.7301412+00:00",
    "utclastchanged": "2025-02-23T06:28:17.7301412+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:28:17.7301412+00:00",
      "utclastchanged": "2025-02-23T06:28:17.7301412+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:28:17.7301412+00:00",
    "utclastchanged": "2025-02-23T06:28:17.7301412+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:28:17.7301412+00:00",
      "utclastchanged": "2025-02-23T06:28:17.7301412+00:00",
      "lastchangedby": "sample string 8"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfcontactmodel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APICOMMON">
  <contactmodel>
    <accountid>16</accountid>
    <altphoneid1>13</altphoneid1>
    <altphoneid2>14</altphoneid2>
    <businessname>sample string 11</businessname>
    <companyid>2</companyid>
    <contactdescription>sample string 12</contactdescription>
    <contactid>1</contactid>
    <contactphonenumber>
      <contactid>2</contactid>
      <lastchangedby>sample string 8</lastchangedby>
      <phoneextension>sample string 5</phoneextension>
      <phoneid>1</phoneid>
      <phonenote>sample string 6</phonenote>
      <phonenumber>sample string 4</phonenumber>
      <phonenumbersearch>sample string 7</phonenumbersearch>
      <phonetype>64</phonetype>
      <utclastchanged>2025-02-23T06:28:17.7301412+00:00</utclastchanged>
      <utctimestamp>2025-02-23T06:28:17.7301412+00:00</utctimestamp>
    </contactphonenumber>
    <contacttype>64</contacttype>
    <emailaddress>sample string 7</emailaddress>
    <firstname>sample string 4</firstname>
    <lastchangedby>sample string 10</lastchangedby>
    <lastname>sample string 6</lastname>
    <middlename>sample string 5</middlename>
    <primaryphoneid>9</primaryphoneid>
    <salutation>sample string 15</salutation>
    <utclastchanged>2025-02-23T06:28:17.7301412+00:00</utclastchanged>
    <utctimestamp>2025-02-23T06:28:17.7301412+00:00</utctimestamp>
    <webaddress>sample string 8</webaddress>
  </contactmodel>
  <contactmodel>
    <accountid>16</accountid>
    <altphoneid1>13</altphoneid1>
    <altphoneid2>14</altphoneid2>
    <businessname>sample string 11</businessname>
    <companyid>2</companyid>
    <contactdescription>sample string 12</contactdescription>
    <contactid>1</contactid>
    <contactphonenumber>
      <contactid>2</contactid>
      <lastchangedby>sample string 8</lastchangedby>
      <phoneextension>sample string 5</phoneextension>
      <phoneid>1</phoneid>
      <phonenote>sample string 6</phonenote>
      <phonenumber>sample string 4</phonenumber>
      <phonenumbersearch>sample string 7</phonenumbersearch>
      <phonetype>64</phonetype>
      <utclastchanged>2025-02-23T06:28:17.7301412+00:00</utclastchanged>
      <utctimestamp>2025-02-23T06:28:17.7301412+00:00</utctimestamp>
    </contactphonenumber>
    <contacttype>64</contacttype>
    <emailaddress>sample string 7</emailaddress>
    <firstname>sample string 4</firstname>
    <lastchangedby>sample string 10</lastchangedby>
    <lastname>sample string 6</lastname>
    <middlename>sample string 5</middlename>
    <primaryphoneid>9</primaryphoneid>
    <salutation>sample string 15</salutation>
    <utclastchanged>2025-02-23T06:28:17.7301412+00:00</utclastchanged>
    <utctimestamp>2025-02-23T06:28:17.7301412+00:00</utctimestamp>
    <webaddress>sample string 8</webaddress>
  </contactmodel>
</ArrayOfcontactmodel>