Field-value pairs for the fields to update (e.g., department, jobTitle, workPhone)
Pitfalls:
Only fields included in the request are updated; others remain unchanged
Some fields are read-only and cannot be updated via API
Field names must match BambooHR's expected field names exactly
Updates are audited; changes appear in the employee's change history
Verify current values with GET_EMPLOYEE before updating to avoid overwriting
5. Manage Dependents and Benefits
When to use: User wants to view employee dependents or benefit coverage
Tool sequence:
BAMBOOHR_DEPENDENTS_GET_ALL - List all dependents [Required]
BAMBOOHR_BENEFIT_GET_COVERAGES - Get benefit coverage details [Optional]
Key parameters:
For dependents: Optional employeeId filter
For benefits: Depends on schema; check RUBE_SEARCH_TOOLS for current parameters
Pitfalls:
Dependent data includes sensitive PII; handle with appropriate care
Benefit coverages may include multiple plan types per employee
Not all BambooHR plans include benefits administration; check account features
Data access depends on API key permissions
Common Patterns
ID Resolution
Employee name -> Employee ID:
1. Call BAMBOOHR_GET_ALL_EMPLOYEES
2. Find employee by name in directory results
3. Extract id (numeric) for detailed operations
Time-off type name -> Type ID:
1. Call BAMBOOHR_GET_META_TIME_OFF_TYPES
2. Find type by name (e.g., 'Vacation', 'Sick Leave')
3. Extract id for time-off requests
Incremental Sync Pattern
For keeping external systems in sync with BambooHR:
1. Store last_sync_timestamp
2. Call BAMBOOHR_EMPLOYEE_GET_CHANGED with since=last_sync_timestamp
3. For each changed employee ID, call BAMBOOHR_GET_EMPLOYEE
4. Process updates in external system
5. Update last_sync_timestamp
Time-Off Workflow
1. GET_META_TIME_OFF_TYPES -> find type ID
2. GET_TIME_OFF_BALANCES -> verify available balance
3. CREATE_TIME_OFF_REQUEST -> submit request
4. UPDATE_TIME_OFF_REQUEST -> approve/deny (manager action)
Known Pitfalls
Employee IDs:
Always numeric integers
Resolve names to IDs via GET_ALL_EMPLOYEES
Terminated employees retain their IDs
Date Formats:
Time-off dates: 'YYYY-MM-DD'
Change detection: ISO 8601 with timezone
Inconsistent formats between endpoints; check each endpoint's schema
Permissions:
API key permissions determine accessible fields and operations
Some operations require admin or manager-level access
Time-off approvals require appropriate role permissions
Sensitive Data:
Employee data includes PII (names, addresses, SSN, etc.)
Handle all responses with appropriate security measures
Dependent data is especially sensitive
Rate Limits:
BambooHR API has rate limits per API key
Bulk operations should be throttled
GET_ALL_EMPLOYEES is more efficient than individual GET_EMPLOYEE calls
Response Parsing:
Response data may be nested under data key
Employee fields vary based on fields parameter
Empty fields may be omitted or returned as null
Parse defensively with fallbacks
Quick Reference
Task
Tool Slug
Key Params
List all employees
BAMBOOHR_GET_ALL_EMPLOYEES
(none)
Get employee details
BAMBOOHR_GET_EMPLOYEE
id, fields
Track changes
BAMBOOHR_EMPLOYEE_GET_CHANGED
since, type
Time-off types
BAMBOOHR_GET_META_TIME_OFF_TYPES
(none)
Time-off balances
BAMBOOHR_GET_TIME_OFF_BALANCES
employeeId
List time-off requests
BAMBOOHR_GET_TIME_OFF_REQUESTS
start, end, employeeId
Create time-off request
BAMBOOHR_CREATE_TIME_OFF_REQUEST
employeeId, timeOffTypeId, start, end
Update time-off request
BAMBOOHR_UPDATE_TIME_OFF_REQUEST
requestId, status
Update employee
BAMBOOHR_UPDATE_EMPLOYEE
id, (field updates)
List dependents
BAMBOOHR_DEPENDENTS_GET_ALL
employeeId
Benefit coverages
BAMBOOHR_BENEFIT_GET_COVERAGES
(check schema)
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
Limitations
Use this skill only when the task clearly matches the scope described above.
Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.