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
employeeUUID

pay_currencyEnum

employment_typeEnum
Access Location information
Location fields
cityString

remote_dataArray

street_2String

stateString

street_1String

countryEnum

zip_codeString

phone_numberString
Access Group information
Group fields
nameString

remote_idString
Access Employee information
Employee fields
remote_dataArray

personal_emailString

genderEnum

last_nameString

ethnicityEnum

work_emailString

marital_statusEnum

start_dateDateTime (ISO 8601)

remote_idString

employee_numberString

home_locationUUID

mobile_phone_numberString

date_of_birthDateTime (ISO 8601)

avatarString

managerUUID

companyUUID

teamUUID

termination_dateDateTime (ISO 8601)

employment_statusEnum

display_full_nameString

first_nameString

work_locationUUID
Access BankInfo information
BankInfo fields
bank_nameString

remote_dataArray

employeeUUID

routing_numberString

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
remote_dataArray

effective_dateDateTime (ISO 8601)

pay_periodEnum

pay_rateNumber

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

remote_dataArray

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

remote_idString

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

remote_dataArray

remote_idString

statusEnum

amountNumber

employeeUUID

start_timeDateTime (ISO 8601)

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

remote_idString

end_dateDateTime (ISO 8601)

provider_nameString

employee_contributionNumber

start_dateDateTime (ISO 8601)

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

remote_dataArray

remote_idString

statusEnum

amountNumber

employeeUUID

employee_noteString

start_timeDateTime (ISO 8601)

approverUUID

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

remote_idString

remote_dataArray
Access Team information
Team fields
nameString

remote_idString

remote_dataArray