
OysterHR
Beta
Merge interacts with OysterHR API endpoints to access certain information as detailed below.
API Endpoints
GET/v1/payroll
Merge interacts with this API endpoint to...
Access PayrollRun information
PayrollRun fields
remote_id
Stringrun_state
Enumremote_data
ArrayAccess EmployeePayrollRun information
EmployeePayrollRun fields
net_pay
Numberremote_data
Arraypayroll_run
UUIDemployee
UUIDAccess Earning information
Earning fields
amount
Numberemployee_payroll_run
UUIDremote_data
ArrayAccess Tax information
Tax fields
amount
Numberemployee_payroll_run
UUIDremote_data
ArrayGET/v1/departments
Merge interacts with this API endpoint to...
Access Group information
Group fields
name
Stringremote_id
Stringremote_data
ArrayGET/v1/company
Merge interacts with this API endpoint to...
Access Company information
Company fields
display_name
Stringremote_id
Stringremote_data
ArrayAccess Employee information
Employee fields
company
UUIDGET/v1/time_off/requests
Merge interacts with this API endpoint to...
Access TimeOff information
TimeOff fields
amount
Numberrequest_type
Enumremote_id
Stringemployee_note
Stringstatus
Enumend_time
DateTime (ISO 8601)remote_data
Arraystart_time
DateTime (ISO 8601)employee
UUIDGET/v1/engagements
Merge interacts with this API endpoint to...
Access Benefit information
Benefit fields
remote_data
Arrayremote_id
Stringprovider_name
Stringemployee
UUIDAccess Location information
Location fields
remote_id
Stringzip_code
Stringcity
Stringstreet_1
Stringstreet_2
Stringremote_data
Arraystate
Stringcountry
EnumAccess Employment information
Employment fields
pay_currency
Enumpay_rate
Numberjob_title
Stringremote_data
Arrayemployment_type
Enumemployee
UUIDAccess Employee information
Employee fields
remote_id
Stringdate_of_birth
DateTime (ISO 8601)display_full_name
Stringmobile_phone_number
Stringwork_email
Stringremote_data
Arrayemployment_status
Enumlast_name
Stringfirst_name
Stringstart_date
DateTime (ISO 8601)