Get a contact by phone number

Returns the full contact record of a contact by phone number

https://api.constructiononline.com/api/Contacts?phone={phone}

This endpoint allows users to search for a specific contact by entering the phone number associated with the contact. If a contact in the user's account matches the provided phone number, information about the contact will be returned. Note that contacts can be assigned more than one phone number (phone and/or mobile). Either number can be entered to return the contact.

• Requests
• Responses

Requests

REQUIRED PARAMETERS

phone: string

• Phone number associated with the contact. Must be the phone or mobile number stored in the property 'PHONE' or 'MOBILE_PHONE' for the contact.
• Should be entered as the complete number, without any special characters or spaces.

Sample URL request

• https://api.constructiononline.com/api/Contacts?phone=3347895666

Example requests in C#, Python, and JavaScript can be found below:

cURL

# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {phone} with the contact's phone

curl https://api.constructiononline.com/api/Contacts?phone={phone} -u {email}:{password} -H 'APIKey:{apikey}'

C#

/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key 
{phone} with the contact's phone number */

public string GetData(string endpoint) {
string username = "{username}";
string password = "{password}";
string apikey = "{apikey}";
HttpResponseMessage response = null;
HttpClientHandler handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
    using (HttpClient client = new HttpClient(handler)) {
        client.Timeout = new TimeSpan(0, 0, 30);
        client.BaseAddress = new Uri("http://api.constructiononline.com");
        client.DefaultRequestHeaders.Accept.Clear();
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", 
System.Convert.ToBase64String(System.Text.Encoding.GetEncoding("ISO-8859-1").GetBytes(username + ":" + password)));
        client.DefaultRequestHeaders.Add("APIKey", apikey);
        client.DefaultRequestHeaders.Add("Accept-Encoding", "gzip");
        response = client.GetAsync(endpoint).Result;
    }
    return response?.Content.ReadAsStringAsync().Result;
}
MessageBox.Show(GetData("api/Contacts?phone={phone}"));

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{phone} with the contact's phone number

import base64, requests, json
apikey = "{apikey}"
username = "{username}"
password = "{password}"
def makeRequest(endpoint):
url = "https://api.constructiononline.com/" + endpoint
userPass = username + ":" + password 
headers = {
"APIKey": apikey,
"Accept-Encoding": "gzip, deflate, br",
"Authorization": "Basic " + base64.b64encode(userPass.encode()).decode(),
}
response = requests.get(url, headers=headers)
return json.dumps(json.loads(response.text), indent=2) 

#Main Program 
print(makeRequest("api/Contacts?phone={phone}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{phone} with the contact's phone number */

username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint) {
    auth = btoa('${username}:${password}');
    var myHeaders = new Headers();
    myHeaders.append("APIKey", apikey);
    myHeaders.append("Accept-Encoding", "gzip, deflate, br");
    myHeaders.append("Authorization", "Basic ${auth}");
    var requestOptions = {
        method: 'GET',
        headers: myHeaders,
        redirect: 'follow'
   };
    fetch("https://api.constructiononline.com/" + endpoint, requestOptions)
        .then(response => response.text())
        .then(result => console.log(result))
        .catch(error => console.log('error', error));
    return response;
};makeRequest("api/Contacts?phone={phone}");

Responses

200: Success

A successful request will return a 200 response with the requested contact in the body, as seen below. Definitions for all returned properties can be found here. 

{
    "ID": 29,
    "FIRSTNAME": "Alice",
    "LASTNAME": "Conway",
    "EMAIL": "aconway@conwaypowerequip.com",
    "ACCOUNT": "999197",
    "LACCESS": "2023-09-21T19:23:10.97",
    "LMOD": "2023-04-21T13:51:13.673",
    "DISPLAY_NAME": "Alice Conway",
    "COMPANY": "Conway Power Equipment",
    "ADDRESS": "1234 Moores Mill Dr",
    "CITY": "Auburn",
    "STATE": "AL",
    "ZIP": "36830",
    "PHONE": "334-789-5666",
    "MOBILE_PHONE": "",
    "MOBILE_PROVIDER": "",
    "FAX": "",
    "LMOD_CON_ID": 29,
    "LMOD_NAME": "Alice Conway",
    "ISCOMPANY": false,
    "MIDDLENAME": "",
    "WEBSITE": "",
    "CREATOR_ID": 29,
    "CREATOR_NAME": "Mark Conway",
    "TIMEZONE_OFFSET": -5.0,
    "AUTO_TIMEZONE": true,
    "COMPANY_ID": 4332,
    "COMPANY_NAME": "Contronics",
    "COUNTRY_SETTING": 1,
    "LANGUAGE_SETTING": 1,
    "LAT": 32.538900,
    "LON": -85.492100,
    "COMPANY_PERMISSIONS": 0,
    "COMPANY_PERMISSIONS_CALENDAR": 0,
    "COMPANY_PERMISSIONS_SCHEDULING": 0,
    "COMPANY_PERMISSIONS_TODOS": 0,
    "COMPANY_PERMISSIONS_CHANGEORDERS": 0,
    "COMPANY_PERMISSIONS_SELECTIONS": 0,
    "COMPANY_PERMISSIONS_PUNCHLISTS": 0,
    "COMPANY_PERMISSIONS_LOGGING": 0,
    "COMPANY_PERMISSIONS_RFI": 0,
    "COMPANY_PERMISSIONS_BUDGETING": 0,
    "COMPANY_PERMISSIONS_TRANSMITTAL": 0,
    "COMPANY_PERMISSIONS_SUBMITTAL": 0,
    "COMPANY_PERMISSIONS_REDLINE": 0,
    "COMPANY_PERMISSIONS_LEADS": 0,
    "COMPANY_PERMISSIONS_TIME": 0,
    "COMPANY_PERMISSIONS_INBOUND_EMAILS": 0,
    "COMPANY_PERMISSIONS_CHECKLISTS": 0,
    "COMPANY_PERMISSIONS_SERVICECALLS": 0,
    "COMPANY_PERMISSIONS_COSTBOOKS": 0,
    "COMPANY_PERMISSIONS_INVOICING": 0,
    "COMPANY_PERMISSIONS_MESSAGING": 0,
    "COMPANY_PERMISSIONS_CLTL_SETTINGS": 0,
    "IS_COMPANY_ADMIN": true,
    "OFFLINE_FILES": null,
    "FAVORITE_PROJECTS": null,
    "DATE_FORMAT": 0,
    "TIME_FORMAT": 0,
    "TIMEZONE_ID": "America/Chicago",
    "CONTACT_QUALITY": 0,
    "CONTACT_REGION": 0,
    "CONTACT_DIVISION": 0,
    "CONTACT_OFFICE": 0,
    "CONTACT_CATEGORY": 0,
    "CONTACT_TRADE": 0,
    "FIELD_ID": 0,
    "MESSAGE_SIGNATURE": "",
    "GENERAL_CALENDAR_COLOR": "#FFA61B"
}