OysterHR
Beta
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with OysterHR API endpoints to access certain information as detailed below.
API Endpoints
GET/v0.1/engagements
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_dataArray
remote_idString
employeeUUID
provider_nameString
benefit_plan_typeString
Access Location information
Location fields
stateString
remote_dataArray
zip_codeString
remote_idString
countryEnum
street_1String
cityString
street_2String
Access Employment information
Employment fields
remote_dataArray
employment_typeEnum
employeeUUID
job_titleString
pay_rateNumber
pay_currencyEnum
Access Employee information
Employee fields
remote_dataArray
first_nameString
remote_idString
work_emailString
start_dateDateTime (ISO 8601)
date_of_birthDateTime (ISO 8601)
display_full_nameString
mobile_phone_numberString
employment_statusEnum
last_nameString
GET/v0.1/company
Merge interacts with this API endpoint to...
Access Employee information
Employee fields
companyUUID
Access Company information
Company fields
remote_dataArray
display_nameString
remote_idString
GET/v0.1/time_off_requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
start_timeDateTime (ISO 8601)
remote_dataArray
remote_idString
end_timeDateTime (ISO 8601)
request_typeEnum
employeeUUID
employee_noteString
statusEnum
amountNumber
GET/v0.1/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
nameString
remote_dataArray
remote_idString
GET/v0.1/payroll
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
remote_dataArray
run_stateEnum
remote_idString
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArray
payroll_runUUID
employeeUUID
net_payNumber
Access Earning information
Earning fields
remote_dataArray
employee_payroll_runUUID
amountNumber
Access Tax information
Tax fields
remote_dataArray
employee_payroll_runUUID
amountNumber