Contact
GET {{base_url}}/contact/:ContactID
Use this endpoint to retrieve a single contact from the Contacts hub.
Response
| FieldName | Description |
|---|
| Company | Name of the firm that is associated with the contact |
| flName | First and last name of the contact |
| ContactID | Unique identifier for the contact record |
| ClientID | Number ID of the firm that is associated with the contact |
| CLAddress | Address of the firm that is associated with the contact |
| Vendor | Number ID of the vendor that is associated with the contact |
| VEAddress | Address of the vendor that is associated with the contact |
| LastName | Family or given name(s) |
| FirstName | First or chosen name |
| MiddleName | Middle name |
| Salutation | Prefix to a person's name from "CodeTable": "CFGPrefix" |
| Suffix | Suffix appended to a name from "CodeTable": "CFGSuffix" |
| Title | Person's professional title typically given to them by the organization to which they belong |
| Address1 | Line 1 of the address |
| Address2 | Line 2 of the address |
| Address3 | Line 3 of the address |
| Address4 | Line 4 of the address |
| City | Name of the City |
| State | Name of the state or province |
| Zip | Postal zip code |
| Country | Name of the country |
| Phone | Phone number |
| Fax | Fax number |
| Pager | Pager telephone number |
| CellPhone | Mobile or cellular telephone number |
| HomePhone | Home telephone number |
| Email | Email address |
| Memo | Notes about the object |
| MailingAddress | Identifies with a Y or N value whether or not the firm address for the contact is a mailing address |
| Billing | Identifies with a Y or N value whether or not the firm address for the contact is designated as a billing address in the Firms hub |
| PrimaryInd | Identifies with a Y or N value whether or not the contact is the primary contact for the firm that the contact is associated with |
| ContactStatus | "A" = The contact is currently active. "I" = The contact is currently dormant or inactive. Valid values from "CodeTable": "ContactStatus". |
| CreateUser | Name of the user who created the contact record |
| CreateDate | Date and time when the record was created |
| ModUser | Name of the user who modified the contact record |
| ModDate | Date and time when the contact record was modified |
| Field | Description |
|---|
| Addressee | Sender's address |
| PreferredName | Name the person prefers to be called, usually a first name, which may differ from the full name provided |
| CustomCurrencyCode | Three digit code that a user chooses to define the type of currency used. Valid values from "CodeTable": "FW_CFGCurrency". |
| Source | Source referenced where the contact was obtained from "CodeTable": "CFGContactSource" |
| PagerFormat | 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 "###.###.####". |
| CellPhoneFormat | 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 | 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 "###.###.####". |
| AjeraSync | Indicates whether or not the Ajera module is active |
| TLInternalKey | TrafficLIVE internal key |
| TLSyncModDate | Date and timestamp when TrafficLIVE synchronization occurred |
| Owner | Employee who is the designated owner |
| StatusReason | Reason why the qualification status was set to new, qualified, or disqualified. CRM Plus module only and lead qualification process must both be enabled. |
| Rating | Two digit score indicating the conversion strength of lead. CRM Plus module only and lead qualification process must both be enabled. |
| Field | Description |
|---|
| FirmDescription | Description of the firm |
| FirmAddress1 | Line 1 of the firm's address |
| FirmAddress2 | Line 2 of the firm's address |
| FirmAddress3 | Line 3 of the firm's address |
| FirmAddress4 | Line 4 of the firm's address |
| FirmCity | Name of the city of the firm |
| FirmState | Name of the state or providence of the firm |
| FirmZip | Postal zip code of the firm |
| FirmCountry | Name of the country where the firm is located |
| FirmBusinessPhone | Business telephone number for the firm |
| FirmBusinessPhoneFormat | 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 | Fax telephone number for the firm |
| FirmBusinessFaxFormat | 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 | Firm's pager telephone number |
| ProjectDescription | 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. |
| Field | Description |
|---|
| Market | Three digit code that identifies the market segment or channel |
| Website | Publicly available website address |
| QualifiedStatus | 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" |
| StatusDate | Reason why the qualification status was set to new, qualified, or disqualified. CRM Plus module only and lead qualification process must both be enabled. |
| ProfessionalSuffix | Professional credential appended to a name usually as an acronym |
| SFID | Globally unique Salesforce identifier |
| emOwnerfl | Full name of the employee designated as the owner |
| TopTPStartDate | Date and timestamp of the most recent touchpoint that shows in the activities list |
| TopTPSubject | Activity name that displays as the last activity subject from for the most recent touchpoint |
| TopTPContactID | Unique identifier for the contact associated with the most recent touchpoint |
| TopTPCreateEmployee | Employee identifier for the most recent touchpoint |
| TopTPCreateUserName | Username of the user who created the most recent touchpoint |
| Field | Description |
|---|
| HasPhoto | 0 or 1. 0 - The object does not have a photo. 1 - The object does have a photo. |
| PhotoModDate | Date and timestamp of when the contact photo was updated |
| ClientName | Name of the client's organization from GET {{base_url}}/firm |
| VName | Alphanumeric short string identifier for the consultant or partner name |
| QBOID | Identifier of the Quickbooks client or vendor |
| QBOIsMainContact | Flag indicating whether or not the Quickbooks client or vendor is the main contact |
| QBOLastUpdated | Date and time the Quickbooks transaction was last changed |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
[{"Company":"Madison Company","flName":"Albert Balfour","ContactID":"AEM45","ClientID":"AEM45","CLAddress":"\u003cDefault\u003e","Vendor":"","VEAddress":"","LastName":"Balfour","FirstName":"Albert","MiddleName":"","Salutation":"Mr.","Suffix":"","Title":"Chief Executive Officer","Address1":"9865 Horsepen Rd","Address2":"","Address3":"","Address4":"","City":"Herndon","State":"MA","Zip":"20171","Country":"","Phone":"202.555.8300","Fax":"202.555.8301","Pager":"","CellPhone":"","HomePhone":"","Email":"email@company.com","Memo":"","MailingAddress":"N","Billing":"N","PrimaryInd":"N","ContactStatus":"I","CreateUser":"Billy Boy Charles, Jr.","CreateDate":"2007-09-04T17:44:57.000","ModUser":"Billy Boy Charles, Jr.","ModDate":"2017-05-04T16:13:42.083","Addressee":"","PreferredName":"","CustomCurrencyCode":"USD","Source":"","PagerFormat":"","CellPhoneFormat":"","HomePhoneFormat":"","AjeraSync":"","TLInternalKey":"","TLSyncModDate":"","Owner":"","StatusReason":"","Rating":"","FirmDescription":"","FirmAddress1":"5312 7th Avenue","FirmAddress2":"","FirmAddress3":"","FirmAddress4":"","FirmCity":"Washington","FirmState":"DC","FirmZip":"24001","FirmCountry":"US","FirmBusinessPhone":"202.555.8300","FirmBusinessPhoneFormat":"","FirmBusinessFax":"202.555.8301","FirmBusinessFaxFormat":"","FirmPager":"","ProjectDescription":"","Market":"","Website":"","QualifiedStatus":"sysQual","StatusDate":"2017-02-23T22:41:21.833","ProfessionalSuffix":"","SFID":"","emOwnerfl":"","RecentOpportunityName":"","RecentOpportunityID":"","RecentOppRole":"","TopTPStartDate":"","TopTPSubject":"","TopTPContactID":"","TopTPCreateEmployee":"","TopTPCreateUserName":"","HasPhoto":0,"PhotoModDate":"","ClientName":"Madison Company","VName":"","QBOID":"","QBOIsMainContact":"N","QBOLastUpdated":"","CustJBsfieldfortestingTouchCRM":"","custNewsletter":"N","custTEST1":"","custCorporateList":"N","custPromotional":"N","custMarket":"","desc_custMarket":"","custPersonal":"","custBirthDate":"","custGolf":"N","custSpouseName":"","custTennis":"N"}]