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

nameString

remote_dataArray
Access Team information
Team fields
remote_idString

nameString

remote_dataArray
GET/v1/employees
Merge interacts with this API endpoint to...
Access Employment information
Employment fields
pay_currencyEnum

employeeUUID

employment_typeEnum
Access Location information
Location fields
remote_dataArray

countryEnum

stateString

street_2String

street_1String

zip_codeString

phone_numberString

cityString
Access Group information
Group fields
remote_idString

nameString
Access Employee information
Employee fields
genderEnum

teamUUID

employment_statusEnum

start_dateDateTime (ISO 8601)

mobile_phone_numberString

last_nameString

companyUUID

employee_numberString

managerUUID

first_nameString

remote_dataArray

marital_statusEnum

termination_dateDateTime (ISO 8601)

home_locationUUID

ethnicityEnum

display_full_nameString

date_of_birthDateTime (ISO 8601)

remote_idString

work_emailString

avatarString

work_locationUUID

personal_emailString
Access BankInfo information
BankInfo fields
remote_dataArray

bank_nameString

routing_numberString

employeeUUID

account_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_frequencyEnum

remote_dataArray

pay_periodEnum

pay_rateNumber

effective_dateDateTime (ISO 8601)
GET/v1/employees/{employee_id}/benefits
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_idString

remote_dataArray

employee_contributionNumber

start_dateDateTime (ISO 8601)

end_dateDateTime (ISO 8601)

provider_nameString

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

nameString

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

statusEnum

end_timeDateTime (ISO 8601)

remote_dataArray

employee_noteString

employeeUUID

start_timeDateTime (ISO 8601)

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

statusEnum

end_timeDateTime (ISO 8601)

remote_dataArray

employee_noteString

request_typeEnum

employeeUUID

start_timeDateTime (ISO 8601)

approverUUID

amountNumber