Read (GET) Employees Associated with a Contact
Use this API to read all employees associated with a contact in the Contacts hub.
To get all employees associated with a specified contact:
Execute a GET command on the endpoint
{{url}}/contact/{{ContactID}}/employee where
ContactID is the ID for the
contact whose
employees you want to retrieve.
For example, using cURL to submit the GET request, here is an example of how to get all employees associated with a contact:
curl --request GET \
--url 'https://{{url}}/contact/{{ContactID}}/employee' \
--header 'authorization: Bearer {{oauth_token}}' \
--header 'content-type: application/json'
The call returns one JSON structure like the following for each employee associated with the specified contact in the Contacts hub. Double quotes in the returned JSON indicate that the field has no data.
{
"Employee": "00101",
"ContactID": "TESTTEST1234567890123",
"Relationship": "01",
"RelationshipDesc": "",
"CreateUser": "LoggedInUser",
"CreateDate": "2017-12-08T17:44:58.567",
"ModUser": "ADMIN",
"ModDate": "2017-12-08T17:44:58.567",
"HomeCompany": "Home Company",
"LastName": "LastName",
"FirstName": "FirstName",
"MiddleName": "MiddleName",
"BillingPool": 0,
"SSN": "012-34-5678",
"Address1": "100 Main Street",
"Address2": "Suite 300",
"Address3": "",
"City": "Boston",
"State": "MA",
"ZIP": "01701-1111",
"Country": "",
"HomePhone": "1234567890"",
"Fax": "1234567890",
"EMail": "email@company.com",
"TKAdminLevel": "0",
"TKAdminEdit": "N",
"EKAdminLevel": "0",
"EKAdminEdit": "N",
"Memo": "",
"EmployeePhoto": "",
"Salutation": "Ms.",
"Suffix": "PE",
"Title": "Structural Engineer",
"ExportInd": "Y",
"WorkPhone": "1234567890",
"WorkPhoneExt": "112",
"MobilePhone": "1234567890",
"AvailableForCRM": "Y",
"ReadyForApproval": "Y",
"PreferredName": "",
"HomePhoneFormat": "",
"FaxFormat": "",
"WorkPhoneFormat": "",
"MobilePhoneFormat": "",
"Language": "en-US",
"TargetRatio": 70,
"UtilizationRatio": 70,
"ConsultantInd": "N",
"ClientVendorInd": "V",
"ClientID": "",
"Vendor": "",
"TalentUserID": "",
"Location": "",
"TLInternalKey": "",
"ProfessionalSuffix": "",
"TalentModDate": "",
"TLSyncModDate": "",
"EmployeeCompany": "PR",
"JobCostRate": 29,
"JobCostType": "H",
"JCOvtPct": 100,
"HoursPerDay": 8,
"HireDate": "1994-04-15T00:00:00.000",
"RaiseDate": "1997-01-01T00:00:00.000",
"Status": "A",
"Type": "E",
"Org": "PR:00:BO:EN",
"Region": "",
"BillingCategory": 7,
"TKGroup": "ST",
"EKGroup": "",
"PayRate": 2320,
"PayType": "S",
"PayOvtPct": 0,
"PaySpecialOvtPct": 0,
"ADPFileNumber": "00003",
"ADPCompanyCode": "",
"ADPRateCode": "111",
"ProvCostRate": 29,
"ProvBillRate": 87,
"ProvCostOTPct": 100,
"ProvBillOTPct": 100,
"DefaultLC1": "",
"DefaultLC2": "",
"DefaultLC3": "",
"DefaultLC4": "",
"DefaultLC5": "",
"ChangeDefaultLC": "Y",
"TerminationDate": "",
"UseTotalHrsAsStd": "N",
"JCSpecialOvtPct": 0,
"ProvCostSpecialOTPct": 0,
"ProvBillSpecialOTPct": 0,
"YearsOtherFirms": 7,
"Supervisor": "00020",
"ReadyForProcessing": "Y",
"CheckHours": "",
"Locale": "",
"LocaleMethod": "0",
"OtherPay": 0,
"OtherPay2": 0,
"OtherPay3": 0,
"OtherPay4": 0,
"OtherPay5": 0,
"CostRateMeth": 0,
"CostRateTableNo": 0,
"PayRateMeth": 0,
"PayRateTableNo": 0,
"PriorYearsFirm": 3,
"PaychexCode1": "",
"PaychexCode2": "",
"PaychexCode3": "",
"IncludeLocalJurisOnly": "N",
"AllowChargeUnits": "N",
"RequireStartEndTime": "N",
"AllowBreakTime": "N",
"DefaultBreakStartDateTime": "",
"DefaultBreakEndDateTime": "",
"PaychexRateNumber": "",
"EmailPayrollRemittance": "N",
"EmailExpenseRemittance": "N",
"OccupationalCode": "",
"GeographicCode": "",
"StatutoryEmployee": "N",
"RetirementPlan": "N",
"ThirdPartySickPay": "N",
"ClieOpTransactionType": "",
"ClieOp": "N",
"ClieOpAccount": "",
"ClieOpAccountType": "",
"SEPAIBAN": "",
"SEPABIC": "",
"TaxRegistrationNumber": "",
"DisableTSRevAudit": "N",
"EmployeeName": "FirstName LastName, ProfessionalSuffix",
"Name": "FirstName LastName, ProfessionalSuffix"
}