Get Contact Reference

The response object fields return when you retrieve contact information by ContactID. For additional detailed information for each field, call the contact metadata endpoint.

Response

Field Description
ContactID Data Type: String
Description: Unique identifier for the contact record
Salutation Data Type: String
Description: Prefix to a person's name from "CodeTable" : "CFGPrefix"
FirstName Data Type: String
Description: First or chosen name
MiddleName Data Type: String
Description: Middle name
LastName Data Type: String
Description: Family or given name(s)
Suffix Data Type: String
Description: Suffix appended to a name from "CodeTable": "CFGSuffix"
PreferredName Data Type: String
Description: Name the person prefers to be called, usually a first name, which may differ from the full name provided
Title Data Type: String
Description: Person's professional title typically given to them by the organization to which they belong
Source Data Type: String
Description: Source referenced where the contact was obtained from "CodeTable": "CFGContactSource"
ClientID Data Type: String
Description: Unique identifier for the client record
ClientName Data Type: String
Description: Name of the client's organization from GET {{url}}/firm
Vendor Data Type: String
Description: Consultant or partner name
Vname Data Type: String
Description: Alphanumeric short string identifier for the consultant or partner name
Email Data Type: String
Description: Email address
ContactStatus Data Type: String
Description: "A" = The contact is currently active. "I" = The contact is currently dormant or inactive. Valid values from "CodeTable": "ContactStatus".
CustomCurrencyCode Data Type: String
Description: Three digit code that a user chooses to define the type of currency used. Valid values from "CodeTable": "FW_CFGCurrency".
Address1 Data Type: String
Description: Line 1 of the address
Address2 Data Type: String
Description: Line 2 of the address
Address3 Data Type: String
Description: Line 3 of the address
Address4 Data Type: String
Description: Line 4 of the address
City Data Type: String
Description: Name of the City
State Data Type: String
Description: Name of the state or province
Zip Data Type: String
Description: Postal zip code
County Data Type: String
Description: Name of the county
Country Data Type: String
Description: Name of the country
Phone Data Type: String
Description: Phone number
Fax Data Type: String
Description: Fax number
CellPhone Data Type: String
Description: Mobile or cellular telephone number
HomePhone Data Type: String
Description: Home telephone number
Pager Data Type: String
Description: Telephone number to page
MailingAddress Data Type: String
Description: "N" or "Y". "Y" designates that this is the physical mailing address which may differ or be the same as the physical office or residential location.
FirmAddress1 Data Type: String
Description: Line 1 of the firm's address
FirmAddress2 Data Type: String
Description: Line 2 of the firm's address
FirmAddress3 Data Type: String
Description: Line 3 of the firm's address
FirmAddress4 Data Type: String
Description: Line 4 of the firm's address
FirmCity Data Type: String
Description: Name of the city of the firm
FirmState Data Type: String
Description: Name of the state or providence of the firm
FirmZip Data Type: String
Description: Postal zip code of the firm
FirmCountry Data Type: String
Description: Name of the country where the firm is located.
FirmBusinessPhone Data Type: String
Description: Business telephone number for the firm
FirmBusinessPhoneFormat Data Type: String
Description: Format of the firm's business telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
FirmBusinessFax Data Type: String
Description: Fax telephone number for the firm
FirmBusinessFaxFormat Data Type: String
Description: Format of the firm's fax telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
FirmPager Data Type: String
Description: Firm's pager telephone number
FirmDescription Data Type: String
Description: Description of the firm
Memo Data Type: String
Description: Notes about the object
Billing Data Type: String
Description: "Y" or "N". "Y" Required, this object is included with the billing application. "N" No, the object is not included with the billing application.
PrimaryInd Data Type: String
Description: "Y" or "N". "Y" Required, this object is primary. "N" No, this object is primary.
Addressee Data Type: String
Description: Sender's address
CLAddress Data Type: String
Description: Client address
VEAddress Data Type: String
Description: Vendor address
CreateUser Data Type: String
Description: Name of the person who created the new record
CreateDate Data Type: String
Description: Date and timestamp when the new record was created
ModUser Data Type: String
Description: Name of the person who modified an existing record of this type
ModDate Data Type: String
Description: Date and timestamp when the existing record of this type was modified
PhoneFormat Data Type: String
Description: Format of the telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
FaxFormat Data Type: String
Description: Format of the fax telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
CellPhoneFormat Data Type: String
Description: Format of the cellular or mobile telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
HomePhoneFormat Data Type: String
Description: Format of the home telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
PagerFormat Data Type: String
Description: Format of the pager telephone number set by admin under Settings > Labels and Lists > Lists in the UI. The API does not support or enforce format validation. Formatting only happens client side when set in the UI. Example response: "(###) ###-###" or "###.###.####".
Company Data Type: String
Description: Company name
flName Data Type: String
Description: Full name with suffix
Owner Data Type: Employee
Description: Employee who is the designated owner
emOwner Data Type: String
Description: Identifier of the employee designated as the owner
emOwnerfl Data Type: String
Description: Full name of the employee designated as the owner
emOwnerPhone Data Type: String
Description: Phone number of the employee designated as the owner
emOwnerEmail Data Type: String
Description: Email address of the employee designated as the owner
emOwnerTitle Data Type: String
Description: Title of the employee designated as the owner
emOwnerLocation Data Type: String
Description: Location of the employee designated as the owner
emParentfl Data Type: String
Description: Full name of the parent organization
RecentOpportunityName Data Type: String
Description: Name of the most recent opportunity
RecentOpportunityID Data Type: String
Description: Unique identifier for the recent opportunity
RecentOppRole Data Type: String
Description: Name of the role for the recent opportunity
TopTPStartDate Data Type: String
Description: Date and timestamp of the most recent touchpoint that shows in the activities list
TopTPSubject Data Type: String
Description: Activity name that displays as the last activity subject from for the most recent touchpoint
TopTPContactID Data Type: String
Description: Unique identifier for the contact associated with the most recent touchpoint
TopTPCreateEmployee Data Type: String
Description: Employee identifier for the most recent touchpoint
TopTPCreateUserName Data Type: String
Description: Username of the user who created the most recent touchpoint
HasPhoto Data Type: Numeric
Description: 0 or 1. 0 - The object does not have a photo. 1 - The object does have a photo.
PhotoModDate Data Type: String
Description: Date and timestamp of when the contact photo was updated
HasBillingTerms Data Type: Numeric
Description: Flag indicating whether or not this project has billing terms and conditions
TLInternalKey Data Type: String
Description: TrafficLIVE internal key
TLSyncModDate Data Type: String
Description: Date and timestamp when TrafficLIVE synchronization occurred
ProjectDescription Data Type: String
Description: Brief description of the project that conveys key points of the business value if the contact has the new lead status. CRM Plus module only and lead qualification process must both be enabled.
Rating Data Type: String
Description: Two digit score indicating the conversion strength of lead. CRM Plus module only and lead qualification process must both be enabled.
Market Data Type: String
Description: Three digit code that identifies the market segment or channel
Website Data Type: String
Description: Publicly available website address
QualifiedStatus Data Type: String
Description: Object's qualification status. CRM Plus module only and lead qualification process must both be enabled. Default: "sysQual". GET contact metadata for codes. Valid statuses: "sysNew", "sysQual", "sysDisqual"
StatusReason Data Type: String
Description: Reason why the qualification status was set to new, qualified, or disqualified. CRM Plus module only and lead qualification process must both be enabled.
StatusDate Data Type: Datetime
Description: When the status was set or changed.
ProfessionalSuffix Data Type: String
Description: Professional credential appended to a name usually as an acronym
SFID Data Type: String
Description: Globally unique Salesforce identifier
SFIDLastModifiedDate Data Type: Datetime
Description: Date and the time Salesforce was last changed
AjeraSync Data Type: String
Description: Indicates whether or not the Ajera module is active