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/employees
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
employment_typeEnum

employeeUUID

pay_currencyEnum
Access Location information
Location fields
countryEnum

cityString

zip_codeString

remote_dataArray

street_1String

street_2String

stateString

phone_numberString
Access Group information
Group fields
remote_idString

nameString
Access Employee information
Employee fields
ethnicityEnum

work_emailString

teamUUID

remote_idString

first_nameString

home_locationUUID

employee_numberString

genderEnum

personal_emailString

managerUUID

start_dateDateTime (ISO 8601)

termination_dateDateTime (ISO 8601)

remote_dataArray

mobile_phone_numberString

marital_statusEnum

display_full_nameString

last_nameString

companyUUID

employment_statusEnum

work_locationUUID

date_of_birthDateTime (ISO 8601)

avatarString
Access BankInfo information
BankInfo fields
account_numberString

remote_dataArray

bank_nameString

routing_numberString

employeeUUID
Access Benefit information
Benefit fields
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

effective_dateDateTime (ISO 8601)

pay_periodEnum

pay_rateNumber

pay_frequencyEnum
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/{employee_id}/benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_idString

start_dateDateTime (ISO 8601)

end_dateDateTime (ISO 8601)

remote_dataArray

provider_nameString

employee_contributionNumber

company_contributionNumber
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_idString

end_timeDateTime (ISO 8601)

remote_dataArray

employee_noteString

amountNumber

statusEnum

employeeUUID

start_timeDateTime (ISO 8601)
GET/v1/leave_requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
remote_idString

end_timeDateTime (ISO 8601)

remote_dataArray

request_typeEnum

employee_noteString

amountNumber

statusEnum

approverUUID

employeeUUID

start_timeDateTime (ISO 8601)