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

GET/v1/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
remote_idString

remote_dataArray

nameString
Access Team information
Team fields
remote_idString

remote_dataArray

nameString
GET/v1/employees
Merge interacts with this API endpoint to...
Access Location information
Location fields
zip_codeString

remote_dataArray

street_1String

stateString

cityString

countryEnum

phone_numberString

street_2String
Access Group information
Group fields
remote_idString

nameString
Access Employee information
Employee fields
date_of_birthDateTime (ISO 8601)

employment_statusEnum

start_dateDateTime (ISO 8601)

work_locationUUID

managerUUID

work_emailString

personal_emailString

display_full_nameString

employee_numberString

ethnicityEnum

genderEnum

companyUUID

teamUUID

termination_dateDateTime (ISO 8601)

remote_idString

marital_statusEnum

remote_dataArray

home_locationUUID

mobile_phone_numberString

avatarString

last_nameString

first_nameString
Access BankInfo information
BankInfo fields
account_numberString

remote_dataArray

bank_nameString

routing_numberString

employeeUUID
Access Benefit information
Benefit fields
employeeUUID
Access Employment information
Employment fields
employment_typeEnum

pay_currencyEnum

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

employee_contributionNumber

end_dateDateTime (ISO 8601)

remote_idString

start_dateDateTime (ISO 8601)

company_contributionNumber

provider_nameString
GET/v1/leave_requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
remote_dataArray

amountNumber

statusEnum

remote_idString

start_timeDateTime (ISO 8601)

end_timeDateTime (ISO 8601)

employee_noteString

employeeUUID

request_typeEnum

approverUUID
GET/v1/account
Merge interacts with this API endpoint to...
Access Company information
Company fields
remote_idString

remote_dataArray

display_nameString
GET/v1/locations
Merge interacts with this API endpoint to...
Access Location information
Location fields
remote_idString

remote_dataArray

nameString
GET/v1/sicknesses
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
remote_dataArray

amountNumber

statusEnum

remote_idString

start_timeDateTime (ISO 8601)

end_timeDateTime (ISO 8601)

employee_noteString

employeeUUID
GET/v1/employee_jobs
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
job_titleString
GET/v1/employees/{employee_id}/salaries
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
remote_dataArray

pay_rateNumber

effective_dateDateTime (ISO 8601)

pay_periodEnum

pay_frequencyEnum