Get Contacts
Use this API to read all contacts currently in the Contacts hub.
To get all contacts:
Execute a GET command on the endpoint
{{url}}/contact/
For example, using cURL to submit the GET request, here is an example of how to get all contacts:
curl --request GET \
--url 'https://{{url}}/contact' \
--header 'authorization: Bearer {{oauth_token}}' \
--header 'content-type: application/json'
The call returns one JSON structure like the following for each contact in the Contacts hub. Double quotes in the returned JSON indicate that the field has no data.
[
{
"ContactID": "21c0c81182f64e7685d3e0ee3efcbfba",
"Salutation": "Mr.",
"FirstName": "Redbox",
"MiddleName": "Brown",
"LastName": "Apple",
"Suffix": "AIA",
"PreferredName": "Red",
"Title": "Program Manager",
"Source": "Newspaper",
"ClientID": "",
"ClientName": "",
"Vendor": "",
"VName": "",
"Email": "email@company.com",
"ContactStatus": "A",
"CustomCurrencyCode": " ",
"Address1": "112 Main Street",
"Address2": "Suit 300",
"Address3": "",
"Address4": "",
"City": "Boston",
"State": "MA",
"Zip": "12345",
"Country": "US",
"Phone": "1234567890",
"Fax": "1234567890",
"CellPhone": "1234567890",
"HomePhone": "1234567890",
"Pager": "1234567890",
"MailingAddress": "Y",
"FirmAddress1": "",
"FirmAddress2": "",
"FirmAddress3": "",
"FirmAddress4": "",
"FirmCity": "",
"FirmState": "",
"FirmZip": "",
"FirmCountry": "US",
"FirmBusinessPhone": "",
"FirmBusinessPhoneFormat": "",
"FirmBusinessFax": "",
"FirmBusinessFaxFormat": "",
"FirmPager": "",
"FirmDescription": "",
"Memo": "",
"Billing": "N",
"PrimaryInd": "N",
"Addressee": "",
"CLAddress": "",
"VEAddress": "",
"CreateUser": "William Apple",
"CreateDate": "2017-04-10T18:56:38.880",
"ModUser": "William Apple",
"ModDate": "2017-04-10T18:56:38.880",
"CellPhoneFormat": "",
"HomePhoneFormat": "",
"PagerFormat": "",
"Company": "",
"flName": "Redbox Apple, AIA",
"ModUserName": "William ",
"Owner": "",
"emOwnerfl": "",
"RecentOpportunityName": "",
"RecentOpportunityID": "",
"RecentOppRole": "",
"TopTPStartDate": "",
"TopTPSubject": "",
"TopTPContactID": "",
"TopTPCreateEmployee": "",
"TopTPCreateUserName": "",
"HasPhoto": 0,
"PhotoModDate": "",
"TLInternalKey": "",
"TLSyncModDate": "",
"ProjectDescription": "",
"Rating": "",
"Market": "",
"Website": "www.deltek.com",
"QualifiedStatus": "undefined",
"StatusReason": "",
"StatusDate": "2017-04-10T18:55:38.000",
"ProfessionalSuffix": "",
"SFID": "",
"AjeraSync": "N",
"custBirthDate": "",
"custNewsletter": "N",
"custCorporateList": "N",
"custSpouseName": "",
"custGolf": "N",
"custPromotional": "N",
"desc_custMarket": "",
"custMarket": "",
"custPersonal": ""
}
]