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

pay_currencyEnum

employeeUUID
Access Location information
Location fields
street_1String

phone_numberString

cityString

remote_dataArray

zip_codeString

stateString

countryEnum

street_2String
Access Group information
Group fields
remote_idString

nameString
Access Employee information
Employee fields
personal_emailString

work_emailString

marital_statusEnum

genderEnum

managerUUID

companyUUID

display_full_nameString

employment_statusEnum

date_of_birthDateTime (ISO 8601)

avatarString

start_dateDateTime (ISO 8601)

employee_numberString

termination_dateDateTime (ISO 8601)

last_nameString

first_nameString

home_locationUUID

remote_idString

mobile_phone_numberString

remote_dataArray

ethnicityEnum

work_locationUUID

teamUUID
Access BankInfo information
BankInfo fields
account_numberString

employeeUUID

remote_dataArray

bank_nameString

routing_numberString
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
pay_rateNumber

pay_frequencyEnum

remote_dataArray

pay_periodEnum

effective_dateDateTime (ISO 8601)
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
end_timeDateTime (ISO 8601)

employeeUUID

start_timeDateTime (ISO 8601)

remote_dataArray

statusEnum

remote_idString

amountNumber

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

approverUUID

request_typeEnum

employeeUUID

start_timeDateTime (ISO 8601)

remote_dataArray

statusEnum

remote_idString

amountNumber

employee_noteString
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
start_dateDateTime (ISO 8601)

remote_dataArray

company_contributionNumber

employee_contributionNumber

remote_idString

end_dateDateTime (ISO 8601)

provider_nameString