Discover more about the contact object and its related properties
Table of Contents
Introduction
Contacts are an essential component of ConstructionOnline. Each contact stores important information about a specific individual, such as their name, email address, trade, division, and more. Individual contacts in ConstructionOnline can also be designated as a specific type, allowing construction companies to easily differentiate between their company employees, clients, leads, subcontractors, and other contacts on their company contact list. With ConstructionOnline's Contacts API, users can easily manage their contact data and integrate it with other contact management or CRM software systems.
Contact Object
A contact object represents an individual contact in ConstructionOnline. Each contact object contains multiple properties that reveal specific details about the contact, such as their name or email address. Each property corresponds to a specific contact detail in ConstructionOnline; these are obtained from a contact's Private Details and Profile Settings in ConstructionOnline.
Each contact object is referenced by a unique numerical ID, which is stored in the property 'ID'. A contact's ID is automatically assigned during creation and cannot be modified. To update or get a specific contact, you must know the contact's ID. Each contact object will contain at least a 'FIRSTNAME', 'LASTNAME', 'EMAIL', and 'DISPLAY_NAME', as these properties are required for creation. The remaining contact object properties are optional. Some properties are automatically assigned a default value when a contact is created. Others will return null if a value has not been set for the specific property. Not all properties will return for each Contacts endpoint.
| Name | Type | Description |
| ID | integer | Unique identifier for the contact. |
| FIRSTNAME | string | Contact's first name. |
| LASTNAME | string | Contact's last name. |
| string | Contact's email address. | |
| DISPLAY_NAME | string | Contact's display name. |
| ACCOUNT | string | Unique identifier for SuiteLink. Only applicable to SuiteLink users. |
| LACCESS | date | Date and time the contact last accessed ConstructionOnline. |
| LMOD | date | Date and time the contact was last modified. |
| COMPANY | string | Company associated with the contact. |
| ADDRESS | string | Contact's street address. |
| CITY | string | Contact's city. |
| STATE | string | Contact's state. |
| ZIP | string | Contact's zip code. |
| PHONE | string | Contact's phone number. |
| MOBILE_PHONE | string | Contact's mobile phone number. |
| MOBILE_PROVIDER | string | Contact's mobile provider. |
| FAX | string | Contact's fax number. |
| LMOD_CON_ID | integer | Unique identifier for the user who last modified the contact. |
| LMOD_NAME | string | Name of the user who last modified the contact. May be referred to as 'Expr1' for some endpoints. |
| ISCOMPANY | boolean | Signifies if the contact is a company contact. Returns 1 if true, 0 if false. |
| MIDDLENAME | string | Contact's middle name. |
| WEBSITE | string | Contact's website. |
| CREATOR_ID | integer | Unique identifier for the user that created the contact. |
| CREATOR_NAME | string | Name of the user who created the contact. May be referred to as 'Expr2' for some endpoints. |
| TIMEZONE_OFFSET | double | Time zone offset for the contact's ConstructionOnline account. |
| AUTO_TIMEZONE | boolean | Signifies if the contact has enabled automatic time zone assignment for their account. |
| COMPANY_ID | integer | Unique identifier for the company associated with the contact. |
| COMPANY_NAME | string | Name of the company associated with the contact. |
| COUNTRY_SETTING | integer | Number representing the specific country associated with the contact's account. |
| LANGUAGE_SETTING | integer | Number representing the specific language associated with the contact's account. |
| LAT | double | Contact's entered latitude coordinates. |
| LON | double | Contact's entered longitude coordinates. |
| COMPANY_PERMISSIONS_X | integer | Only applicable to Company Users. Unique identifier that represents the combination of Employee Permissions the contact has. |
| IS_COMPANY_ADMIN | boolean | Represents Company Admin Users. Will return true if the contact is a Company Admin User, false if not. |
| OFFLINE_FILES | string | Any files saved with the contact. |
| DATE_FORMAT | byte | Number representing the specific date format associated with the contact's account. |
| TIME_FORMAT | byte | Number representing the specific time format associated with the contact's account. |
| TIMEZONE_ID | string | Contact's time zone. |
| CONTACT_QUALITY | integer | Quality associated with the contact. Returns the star rating as a integer between 1 and 5. Returns null if no rating has been assigned. |
| MESSAGE_SIGNATURE | string | Contact's message signature. If the message contains any HTML formatted text, such as bolded letters or special characters, the returning string will be encoded. |
| GENERAL_CALENDAR_COLOR | string | Color of the contact's Personal Calendar in ConstructionOnline. Returns the specific hex code for the color. Default value is set as #DFECF5. |
| IS_LEAD | integer | Signifies if the contact is a Lead. Returns 1 if true, 0 if false. |
| IS_SUB | integer | Signifies if the contact is a TeamLink Contact. Returns 1 if true, 0 if false. |
| IS_CLIENT | integer | Signifies if the contact is a ClientLink Contact. Returns 1 if true, 0 if false. |
In addition to the properties above, contact objects also return properties that reference custom values for the user's company account. Custom values are fields that can be customized for each company to best fit their specific needs, and are denoted by a gear icon ⚙️ beside the field heading.
Each custom value property will return the numerical ID that represents the specific custom value entry assigned to the contact. To ensure you know the meaning of the returned value, we highly recommend storing your company's custom value entries in a data table or collection for reference. This endpoint can be used to return all custom values for your company's account.
| Name | Type | Description |
| CONTACT_REGION | integer | Corresponds to the 'Region' custom value. Returns the numerical ID for the specific region associated with the contact. |
| CONTACT_DIVISION | integer | Corresponds to the 'Division' custom value. Returns the numerical ID for the specific division associated with the contact. |
| CONTACT_OFFICE | integer | Corresponds to the 'Office' custom value. Returns the numerical ID for the specific office associated with the contact. |
| CONTACT_CATEGORY | integer | Corresponds to the 'Contact Category' custom value. Returns the numerical ID for the specific category associated with the contact. |
| CONTACT_TRADE | integer | Corresponds to the 'Trade' custom value. Returns the numerical ID for the specific trade associated with the contact. |
| FIELD_ID | integer | Corresponds to the 'Contact Group' custom value. Returns the numerical ID for the specific contact group associated with the contact. |
Example contact object
{
"ID": 29,
"FIRSTNAME": "Alice",
"LASTNAME": "Conway",
"EMAIL": "alice@conwayconstruction.com",
"ACCOUNT": "999197",
"LACCESS": "2023-09-21T19:23:10.97",
"LMOD": "2023-04-21T13:51:13.673",
"DISPLAY_NAME": "Alice Conway",
"COMPANY": "Conway Construction",
"ADDRESS": "1234 Moores Mill Dr",
"CITY": "Auburn",
"STATE": "AL",
"ZIP": "36830",
"PHONE": "334-345-8976",
"MOBILE_PHONE": "334-789-5666",
"MOBILE_PROVIDER": "",
"FAX": "",
"LMOD_CON_ID": 29,
"LMOD_NAME": "",
"ISCOMPANY": false,
"MIDDLENAME": "",
"WEBSITE": "",
"CREATOR_ID": 29,
"CREATOR_NAME": "",
"TIMEZONE_OFFSET": -5.0,
"AUTO_TIMEZONE": true,
"COMPANY_ID": 4332,
"COMPANY_NAME": "",
"COUNTRY_SETTING": 1,
"LANGUAGE_SETTING": 1,
"LAT": 32.538900,
"LON": -85.492100,
"COMPANY_PERMISSIONS": 0,
"IS_COMPANY_ADMIN": true,
"OFFLINE_FILES": 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": null,
"MESSAGE_SIGNATURE": "",
"GENERAL_CALENDAR_COLOR": "#FFA61B",
"IS_LEAD": 0,
"IS_SUB": 0,
"IS_CLIENT": 0
}
Endpoints