GET Phone?phoneNumber={phoneNumber}&countryCode={countryCode}
Fetches the first Phone object that matches the provided information.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| phoneNumber |
Phone Number to search for |
string |
Required |
| countryCode |
Country Code for the phone number |
string |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
A single Phone object, if found
Phone| Name | Description | Type | Additional information |
|---|---|---|---|
| PhoneID | integer |
None. |
|
| VIPID | globally unique identifier |
None. |
|
| PhoneNumber | string |
None. |
|
| CountryCode | string |
None. |
|
| IsActive | boolean |
None. |
|
| DateCreated | date |
None. |
|
| DateModified | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"phoneID": 1,
"vipid": "c0a98ec3-ccd8-4cff-ba35-4df154a25e0a",
"phoneNumber": "sample string 2",
"countryCode": "sample string 3",
"isActive": true,
"dateCreated": "2026-04-21T06:47:37.567918-04:00",
"dateModified": "2026-04-21T06:47:37.567918-04:00"
}
text/html
Sample:
{"phoneID":1,"vipid":"c0a98ec3-ccd8-4cff-ba35-4df154a25e0a","phoneNumber":"sample string 2","countryCode":"sample string 3","isActive":true,"dateCreated":"2026-04-21T06:47:37.567918-04:00","dateModified":"2026-04-21T06:47:37.567918-04:00"}
application/xml, text/xml
Sample:
<Phone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContactService.Models"> <CountryCode>sample string 3</CountryCode> <DateCreated>2026-04-21T06:47:37.567918-04:00</DateCreated> <DateModified>2026-04-21T06:47:37.567918-04:00</DateModified> <IsActive>true</IsActive> <PhoneID>1</PhoneID> <PhoneNumber>sample string 2</PhoneNumber> <VIPID>c0a98ec3-ccd8-4cff-ba35-4df154a25e0a</VIPID> </Phone>