Skip to main content
Server path: /bamboohr-time | Type: Application | PCID required: Yes

Tools

ToolDescription
bamboohr_time_adjust_time_off_balanceAdjust Time Off Balance
bamboohr_time_assign_employees_to_break_policyAssign Employees to Break Policy
bamboohr_time_assign_time_off_policiesAssign Time Off Policies
bamboohr_time_assign_time_off_policies_v1_1Assign Time Off Policies v1.1
bamboohr_time_create_breakCreate Break
bamboohr_time_create_break_policyCreate Break Policy
bamboohr_time_create_or_update_time_tracking_hour_recordsCreate or Update Hour Records
bamboohr_time_create_or_update_timesheet_clock_entriesCreate or Update Timesheet Clock Entries
bamboohr_time_create_or_update_timesheet_hour_entriesCreate or Update Timesheet Hour Entries
bamboohr_time_create_time_off_historyCreate Time Off History Item
bamboohr_time_create_time_off_requestCreate Time Off Request
bamboohr_time_create_time_tracking_hour_recordCreate Hour Record
bamboohr_time_create_time_tracking_projectCreate Time Tracking Project
bamboohr_time_create_timesheet_clock_in_entryCreate Timesheet Clock-In Entry
bamboohr_time_create_timesheet_clock_out_entryCreate Timesheet Clock-Out Entry
bamboohr_time_delete_breakDelete Break
bamboohr_time_delete_break_policyDelete Break Policy
bamboohr_time_delete_timesheet_clock_entries_via_postDelete Timesheet Clock Entries
bamboohr_time_delete_timesheet_hour_entries_via_postDelete Timesheet Hour Entries
bamboohr_time_delete_tracking_hour_recordDelete Hour Record
bamboohr_time_get_breakGet Break
bamboohr_time_get_break_policyGet Break Policy
bamboohr_time_get_off_balanceGet Time Off Balance
bamboohr_time_get_tracking_recordGet Time Tracking Record
bamboohr_time_list_break_assessmentsList Break Assessments
bamboohr_time_list_break_policiesList Break Policies
bamboohr_time_list_break_policy_breaksList Breaks for Break Policy
bamboohr_time_list_break_policy_employeesList Break Policy Employees
bamboohr_time_list_employee_break_availabilitiesList Employee Break Availabilities
bamboohr_time_list_employee_break_policiesList Employee Break Policies
bamboohr_time_list_employee_time_off_policiesList Employee Time Off Policies
bamboohr_time_list_employee_time_off_policies_v1_1List Employee Time Off Policies v1.1
bamboohr_time_list_time_off_policiesList Time Off Policies
bamboohr_time_list_time_off_requestsList Time Off Requests
bamboohr_time_list_time_off_typesList Time Off Types
bamboohr_time_list_timesheet_entriesList Timesheet Entries
bamboohr_time_list_whos_outList Who’s Out
bamboohr_time_replace_breaks_for_break_policyReplace Breaks for Break Policy
bamboohr_time_set_break_policy_employeesSet Employees for Break Policy
bamboohr_time_sync_break_policySync Break Policy
bamboohr_time_unassign_employees_from_break_policyUnassign Employees from Break Policy
bamboohr_time_update_breakUpdate Break
bamboohr_time_update_break_policyUpdate Break Policy
bamboohr_time_update_time_off_request_statusUpdate Time Off Request Status
bamboohr_time_update_time_tracking_recordUpdate Hour Record

bamboohr_time_adjust_time_off_balance

Adjust Time Off Balance Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee.
amountnumberNoThe number of hours/days to adjust the balance by.
datestringNoThe date the adjustment should be added in history. Should be in ISO8601 date format (YYYY-MM-DD).
notestringNoThis is an optional note to show in history.
timeOffTypeIdintegerNoThe ID of the time off type to add a balance adjustment for.

bamboohr_time_assign_employees_to_break_policy

Assign Employees to Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
employeeIdsinteger[]YesArray of employee IDs to assign to the break policy

bamboohr_time_assign_time_off_policies

Assign Time Off Policies Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee to assign policies to.
bodyobject[]YesRequest body

bamboohr_time_assign_time_off_policies_v1_1

Assign Time Off Policies v1.1 Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee to assign policies to.
bodyobject[]YesRequest body

bamboohr_time_create_break

Create Break Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
availabilityEndTimestringNoLatest time the break can be taken (HH:MM format)
availabilityMaxHoursWorkednumberNoMaximum hours that can be worked before the break must be taken
availabilityMinHoursWorkednumberNoMinimum hours that must be worked before the break can be taken
availabilityStartTimestringNoEarliest time the break can be taken (HH:MM format)
availabilityTypeobjectNoWhen the break is available to be taken
durationintegerNoDuration of the break in minutes
namestringNoThe name of the break
paidbooleanNoWhether the break is paid
policyIdstringNoThe unique identifier of the break policy this break belongs to

bamboohr_time_create_break_policy

Create Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
allEmployeesAssignedbooleanNoWhether all employees are assigned to this break policy
breaksobject[]NoCollection of time tracking breaks to create or update without a policy
descriptionstringNoOptional description of the break policy
employeeIdsinteger[]NoThe employees that should be assigned to this policy
namestringYesName of the break policy

bamboohr_time_create_or_update_time_tracking_hour_records

Create or Update Hour Records Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]YesRequest body

bamboohr_time_create_or_update_timesheet_clock_entries

Create or Update Timesheet Clock Entries Parameters:
ParameterTypeRequiredDefaultDescription
entriesobject[]YesArray of clock entries

bamboohr_time_create_or_update_timesheet_hour_entries

Create or Update Timesheet Hour Entries Parameters:
ParameterTypeRequiredDefaultDescription
hoursobject[]YesArray of hour entries to add or update

bamboohr_time_create_time_off_history

Create Time Off History Item Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee.
amountnumberNoThe number of hours/days to record. Required when eventType is override.
datestringNoThe date for the history item in YYYY-MM-DD format.
eventTypestringNoThe type of history event. Defaults to used for the /history path and override for the /balance_adjustment path when omitted.
notestringNoAn optional note to show in history.
timeOffRequestIdintegerNoThe ID of an approved time off request. Required when eventType is used.
timeOffTypeIdintegerNoThe ID of the time off type. Required when eventType is override.

bamboohr_time_create_time_off_request

Create Time Off Request Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee to create the time off request for.
amountnumberNoTotal hours or days requested. Ignored when dates array is provided (sum of daily amounts is used instead).
datesobject[]NoOptional per-day breakdown. When provided, the top-level amount is ignored and the sum of daily amounts is used.
endstringNoEnd date in YYYY-MM-DD format. Must be on or after the start date.
notesobject[]NoOptional notes from the employee or manager.
previousRequestintegerNoThe ID of a previous time off request to supersede. The previous request will be cancelled.
startstringNoStart date in YYYY-MM-DD format.
statusstringNoThe initial status of the request.
timeOffTypeIdintegerNoThe ID of the time off type for this request.

bamboohr_time_create_time_tracking_hour_record

Create Hour Record Parameters:
ParameterTypeRequiredDefaultDescription
dateHoursWorkedstringYesThe date the hours were worked. Please use the ISO-8601 date format YYYY-MM-DD.
departmentIdintegerNo[Optional] The ID of the department for the employee.
divisionIdintegerNo[Optional] The ID of the division for the employee.
employeeIdintegerYesThe ID of the employee.
hoursWorkednumberYesThe number of hours worked.
jobCodeintegerNo[Optional] A job code.
jobDatastringNo[Optional] A list of up to four 20 characters max job numbers in comma delimited format with no spaces.
jobTitleIdintegerNo[Optional] The ID of the job title for the employee.
payCodestringNo[Optional] Only necessary if the payroll provider requires a pay code
payRatenumberNo[Optional] The rate of pay. e.g. $15.00/hour should use 15.00 here. Only necessary if the payroll provider requires a pay rate.
rateTypestringYesThe type of hours - regular or overtime. Please use either “REG”, “OT”, or “DT” here.
timeTrackingIdstringYesA unique identifier for the record. Use this ID to adjust or delete these hours. It can be any ID you use to track the record up to 36 characters in length. (i.e. UUID).

bamboohr_time_create_time_tracking_project

Create Time Tracking Project Parameters:
ParameterTypeRequiredDefaultDescription
allowAllEmployeesbooleanNoIndicates if all employees can log time for this project. Defaults to true if not provided.
billablebooleanNoIndicates if the project is billable. Defaults to true if not provided.
employeeIdsinteger[]NoA list of employee IDs that can log time for this project. Only used when allowAllEmployees is false.
hasTasksbooleanNoIndicates if the project has tasks. Defaults to false if not provided.
namestringYesName of the project. Must be unique and no more than 50 characters.
tasksobject[]NoList of tasks to create and associate with the project.

bamboohr_time_create_timesheet_clock_in_entry

Create Timesheet Clock-In Entry Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesID of the employee to clock in.
breakIdstringNoID of the break that should be associated with the timesheet entry.
datestringNoDate for the timesheet entry. Must be in YYYY-MM-DD format.
notestringNoThe note that should be associated with the timesheet entry
offlinebooleanNoWhether this is an offline punch. When true, bypasses the shift schedule clock-in restriction. Intended for devices that store punches offline and sync later.
projectIdintegerNoID of the time tracking project that should be associated with the timesheet entry. Required if taskId is specified.
startstringNoThe time for the clock in. In 24 hour format HH:MM
taskIdintegerNoID of the time tracking task that should be associated with the timesheet entry.
timezonestringNoThe timezone associated with the clock in.

bamboohr_time_create_timesheet_clock_out_entry

Create Timesheet Clock-Out Entry Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesID of the employee to clock out.
datestringNoDate for the timesheet entry. Must be in YYYY-MM-DD format.
endstringNoThe time for the clock out. In 24 hour format HH:MM
timezonestringNoThe timezone associated with the clock out.

bamboohr_time_delete_break

Delete Break Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break ID.

bamboohr_time_delete_break_policy

Delete Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.

bamboohr_time_delete_timesheet_clock_entries_via_post

Delete Timesheet Clock Entries Parameters:
ParameterTypeRequiredDefaultDescription
clockEntryIdsinteger[]YesArray of clock entry IDs to process

bamboohr_time_delete_timesheet_hour_entries_via_post

Delete Timesheet Hour Entries Parameters:
ParameterTypeRequiredDefaultDescription
hourEntryIdsinteger[]YesArray of hour entry IDs to process

bamboohr_time_delete_tracking_hour_record

Delete Hour Record Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe time tracking id is the id that was used to track the record up to 36 characters in length. (i.e. UUID).

bamboohr_time_get_break

Get Break Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break ID.

bamboohr_time_get_break_policy

Get Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
includeCountsbooleanNoInclude employee and break counts

bamboohr_time_get_off_balance

Get Time Off Balance Parameters:
ParameterTypeRequiredDefaultDescription
endstringNoThe date to calculate the time off balance as of, in YYYY-MM-DD format. Defaults to company today if not provided. Example: use a future date to project balance.
precisionintegerNoNumber of decimal places for balance and usedYearToDate values. Minimum 0, maximum 4. Defaults to 2.
employeeIdintegerYesThe ID of the employee to get time off balances for.

bamboohr_time_get_tracking_record

Get Time Tracking Record Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe time tracking record ID used to originally create the record.

bamboohr_time_list_break_assessments

List Break Assessments Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoNumber of items to skip before returning results. Defaults to 0.
limitintegerNoMaximum number of items to return. Defaults to 100. Maximum is 500.
filterstringNoOData v4 filter expression. Filterable fields: id, breakId, employeeId, employeeTimesheetId, date, result, availableYmdt, unavailableYmdt, createdAt, updatedAt, expectedDuration, recordedDuration, durationDifference.

bamboohr_time_list_break_policies

List Break Policies Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe offset of items to retrieve
limitintegerNoThe maximum items to retrieve
filterstringNoFilter by an OData (Open Data Protocol) v4 specification
includeCountsbooleanNoInclude employee and break counts

bamboohr_time_list_break_policy_breaks

List Breaks for Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
offsetintegerNoThe offset of items to retrieve
limitintegerNoThe maximum items to retrieve
filterstringNoFilter by an OData (Open Data Protocol) v4 specification

bamboohr_time_list_break_policy_employees

List Break Policy Employees Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
offsetintegerNoThe offset of items to retrieve
limitintegerNoThe maximum items to retrieve

bamboohr_time_list_employee_break_availabilities

List Employee Break Availabilities Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe employee ID.
effectivestringNoThe employee’s local time that should be used to calculate availability. Defaults to the current time. Must be in Y-m-d\TH:i:s format (no timezone offset).

bamboohr_time_list_employee_break_policies

List Employee Break Policies Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe employee ID.
offsetintegerNoThe number of items to skip before starting to collect the result set. Minimum 0. Defaults to 0.
limitintegerNoThe maximum number of items to return. Must be between 0 and 500. Defaults to 100.

bamboohr_time_list_employee_time_off_policies

List Employee Time Off Policies Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee.

bamboohr_time_list_employee_time_off_policies_v1_1

List Employee Time Off Policies v1.1 Parameters:
ParameterTypeRequiredDefaultDescription
employeeIdintegerYesThe ID of the employee.

bamboohr_time_list_time_off_policies

List Time Off Policies

bamboohr_time_list_time_off_requests

List Time Off Requests Parameters:
ParameterTypeRequiredDefaultDescription
idintegerNoA particular request ID to limit the response to.
actionstringNoLimit to requests the caller can view, requests they can approve, or only their own requests via myRequests. Defaults to view.
employeeIdintegerNoA particular employee ID to limit the response to.
startstringYesOnly include requests that end on or after this date. YYYY-MM-DD format.
endstringYesOnly include requests that start on or before this date. YYYY-MM-DD format.
typestringNoA comma-separated list of time off type IDs to filter by. If omitted, requests of all types are included.
statusstringNoA comma-separated list of request status values to filter by. Accepted values are approved, denied, superceded, requested, and canceled. If omitted, requests of all statuses are included.
excludeNotestringNoWhen set to any truthy value, omits the notes object from each request in the response.

bamboohr_time_list_time_off_types

List Time Off Types Parameters:
ParameterTypeRequiredDefaultDescription
modestringNoSet to request to limit the results to time off types the authenticated employee can request.

bamboohr_time_list_timesheet_entries

List Timesheet Entries Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesYYYY-MM-DD. Only show timesheet entries on/after the specified start date. Must be within the last 365 days.
endstringYesYYYY-MM-DD. Only show timesheet entries on/before the specified end date. Must be within the last 365 days.
employeeIdsstringNoA comma separated list of employee IDs. When specified, only entries that match these employee IDs are returned. When omitted, entries for all accessible employees are returned.

bamboohr_time_list_whos_out

List Who’s Out Parameters:
ParameterTypeRequiredDefaultDescription
startstringNoStart date in YYYY-MM-DD format. Defaults to today.
endstringNoEnd date in YYYY-MM-DD format. Defaults to 14 days after the start date.
filterstringNoSet to off to disable the Who’s Out visibility filter and return the unfiltered feed. Any other value leaves filtering enabled.

bamboohr_time_replace_breaks_for_break_policy

Replace Breaks for Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
bodyobject[]YesCollection of time tracking breaks to create or update without a policy

bamboohr_time_set_break_policy_employees

Set Employees for Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
employeeIdsinteger[]NoArray of employee IDs to assign to the break policy. Replaces all existing assignments.

bamboohr_time_sync_break_policy

Sync Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
allEmployeesAssignedbooleanNoWhether all employees are assigned to this break policy
breaksobject[]NoCollection of time tracking breaks to create or update without a policy
descriptionstringNoOptional description of the break policy
employeeIdsinteger[]NoThe employees that should be assigned to this policy
namestringNoName of the break policy

bamboohr_time_unassign_employees_from_break_policy

Unassign Employees from Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
employeeIdsinteger[]YesArray of employee IDs to unassign from the break policy

bamboohr_time_update_break

Update Break Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break ID.
availabilityEndTimestringNoLatest time the break can be taken (HH:MM format)
availabilityMaxHoursWorkednumberNoMaximum hours that can be worked before the break must be taken
availabilityMinHoursWorkednumberNoMinimum hours that must be worked before the break can be taken
availabilityStartTimestringNoEarliest time the break can be taken (HH:MM format)
availabilityTypeobjectNoWhen the break is available to be taken
durationintegerNoDuration of the break in minutes
namestringNoThe name of the break
paidbooleanNoWhether the break is paid
policyIdstringNoThe unique identifier of the break policy this break belongs to

bamboohr_time_update_break_policy

Update Break Policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe break policy ID.
allEmployeesAssignedbooleanNoWhether all employees are assigned to this break policy
descriptionstringNoOptional description of the break policy
namestringNoName of the break policy

bamboohr_time_update_time_off_request_status

Update Time Off Request Status Parameters:
ParameterTypeRequiredDefaultDescription
requestIdintegerYesThe ID of the time off request to update.
notestringNoA note to attach to the change in status.
statusstringNoThe new status for the time off request.

bamboohr_time_update_time_tracking_record

Update Hour Record Parameters:
ParameterTypeRequiredDefaultDescription
holidayIdintegerNoID of the holiday associated with this time tracking record
hoursWorkednumberNoThe updated number of hours worked. e.g. if Employee A worked 8.0 hours originally and decided they only worked 6.0, please send 6.0 here not -2.0.
projectIdintegerNoID of the project associated with this time tracking record
shiftDifferentialIdintegerNoID of the shift differential associated with this time tracking record
taskIdintegerNoID of the task associated with this time tracking record
timeTrackingIdstringNoThe time tracking id is the id that was used to track the record up to 36 characters in length. (i.e. UUID).