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_dataArray

deduction_codeString

descriptionString

benefit_plan_typeEnum

nameString

remote_idString
GET/v1/companies/{company_id}/employees
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
employeeUUID
Access Employee information
Employee fields
teamUUID

personal_emailString

last_nameString

employment_statusEnum

mobile_phone_numberString

managerUUID

termination_dateDateTime (ISO 8601)

work_emailString

preferred_nameString

display_full_nameString

start_dateDateTime (ISO 8601)

first_nameString

date_of_birthDateTime (ISO 8601)

remote_dataArray

home_locationUUID

remote_idString
Access Location information
Location fields
street_2String

zip_codeString

street_1String

countryEnum

cityString

stateString

remote_dataArray

remote_idString
Access Employment information
Employment fields
pay_rateNumber

flsa_statusEnum

job_titleString

effective_dateDateTime (ISO 8601)

employeeUUID

employment_typeEnum

pay_periodEnum

remote_dataArray

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

provider_nameString

remote_dataArray

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

legal_nameString

remote_dataArray

remote_idString
Access Location information
Location fields
street_2String

zip_codeString

street_1String

countryEnum

cityString

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

zip_codeString

street_1String

countryEnum

cityString

stateString

remote_dataArray

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

remote_dataArray

remote_idString
Access Team information
Team fields
nameString

remote_dataArray

remote_idString
GET/v1/companies/{company_id}/payrolls
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
run_typeEnum

end_dateDateTime (ISO 8601)

run_stateEnum

start_dateDateTime (ISO 8601)

check_dateDateTime (ISO 8601)

remote_dataArray

remote_idString
Access EmployeePayrollRun information
EmployeePayrollRun fields
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
end_dateDateTime (ISO 8601)

gross_payNumber

net_payNumber

employeeUUID

start_dateDateTime (ISO 8601)

remote_dataArray
Access Tax information
Tax fields
remote_dataArray

employee_payroll_runUUID

amountNumber

employer_taxBoolean

nameString
Access Deduction information
Deduction fields
remote_dataArray

employee_payroll_runUUID

employee_deductionNumber

nameString

company_deductionNumber
Access Earning information
Earning fields
typeEnum

amountNumber

remote_dataArray

employee_payroll_runUUID
Access Employment information
Employment fields
remote_dataArray

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

pay_group_nameString

remote_idString
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
street_2String

zip_codeString

street_1String

countryEnum

cityString

stateString

remote_dataArray
Access Employee information
Employee fields
employment_statusEnum

last_nameString

termination_dateDateTime (ISO 8601)

work_emailString

work_locationUUID

preferred_nameString

start_dateDateTime (ISO 8601)

first_nameString

remote_dataArray

home_locationUUID

remote_idString
Access Employment information
Employment fields
pay_rateNumber

effective_dateDateTime (ISO 8601)

employeeUUID

pay_frequencyEnum

pay_periodEnum

remote_dataArray