Gusto
Common Model Sync Frequencies
Accessed third-party endpoints
Merge interacts with Gusto API endpoints to access certain information as detailed below.
API Endpoints

GET/v1/companies/{company_id}/company_benefits
Merge interacts with this API endpoint to...
Access EmployerBenefit information
EmployerBenefit fields
remote_idString

remote_dataArray

deduction_codeString

benefit_plan_typeEnum

nameString

descriptionString
GET/v1/companies/{company_id}/employees
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
employeeUUID
Access Employee information
Employee fields
date_of_birthDateTime (ISO 8601)

preferred_nameString

mobile_phone_numberString

remote_idString

termination_dateDateTime (ISO 8601)

start_dateDateTime (ISO 8601)

first_nameString

remote_dataArray

display_full_nameString

personal_emailString

managerUUID

work_emailString

employment_statusEnum

last_nameString
Access Employment information
Employment fields
pay_rateNumber

employeeUUID

remote_idString

flsa_statusEnum

remote_dataArray

effective_dateDateTime (ISO 8601)

employment_typeEnum

job_titleString

pay_periodEnum
GET/v1/employees/{employee_id}/employee_benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_dataArray

benefit_plan_typeString

provider_nameString

remote_idString
GET/v1/companies/{company_id}
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_dataArray

display_nameString

remote_idString

legal_nameString
Access Location information
Location fields
countryEnum

cityString

stateString

zip_codeString

street_1String

street_2String
GET/v1/companies/{id}/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_dataArray

nameString

remote_idString
GET/v1/employees/{employee_id}/home_addresses
Merge interacts with this API endpoint to...
Access Location information
Location fields
countryEnum

cityString

stateString

remote_idString

remote_dataArray

zip_codeString

street_1String

street_2String
GET/v1/companies/{company_id}/pay_schedules
Merge interacts with this API endpoint to...
Access PayGroup information
PayGroup fields
remote_dataArray

remote_idString

pay_group_nameString
GET/v1/companies/{company_id}/pay_schedules/assignments
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_frequencyEnum
GET/v1/companies/{company_id}/contractors
Merge interacts with this API endpoint to...
Access Location information
Location fields
countryEnum

cityString

stateString

remote_dataArray

zip_codeString

street_1String

street_2String
Access Employee information
Employee fields
start_dateDateTime (ISO 8601)

preferred_nameString

remote_idString

home_locationUUID

first_nameString

remote_dataArray

employment_statusEnum

work_emailString

work_locationUUID

last_nameString
Access Employment information
Employment fields
pay_rateNumber

employeeUUID

remote_dataArray

pay_frequencyEnum

effective_dateDateTime (ISO 8601)

pay_periodEnum
GET/v1/employees/{employee_id}/work_addresses
Merge interacts with this API endpoint to...
Access Location information
Location fields
countryEnum

cityString

stateString

remote_idString

remote_dataArray

zip_codeString

street_1String

street_2String
GET/v1/companies/{company_id}/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
start_dateDateTime (ISO 8601)

remote_idString

run_typeEnum

remote_dataArray

end_dateDateTime (ISO 8601)

check_dateDateTime (ISO 8601)

run_stateEnum
Access EmployeePayrollRun information
EmployeePayrollRun fields
start_dateDateTime (ISO 8601)

end_dateDateTime (ISO 8601)

payroll_runUUID

check_dateDateTime (ISO 8601)
GET/v1/companies/{company_id}/payrolls/{payroll_id}
Merge interacts with this API endpoint to...
Access EmployeePayrollRun information
EmployeePayrollRun fields
remote_dataArray

employeeUUID

gross_payNumber

net_payNumber
Access Tax information
Tax fields
amountNumber

remote_dataArray

employer_taxBoolean

nameString

employee_payroll_runUUID
Access Deduction information
Deduction fields
remote_dataArray

employee_payroll_runUUID

nameString

employee_deductionNumber
Access Earning information
Earning fields
remote_dataArray

employee_payroll_runUUID

amountNumber

typeEnum