BambooHR

BambooHR HR system: employee directory, employee records, time off requests, who is out, and time off types.

5 actions API key 5 read0 write Calls bamboohr.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "bamboohr" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Get employee directoryreadbamboohr.get_directoryList the company's employee directory: names, job titles, departments and contact details that the directory shows. Use onlyCurrent false to include future hires.

Input	Type		Description
`only_current`	boolean	Optional	False to include employees with a future hire date (default true)

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bamboohr.get_directory",
  input: {},
});

Get employeereadbamboohr.get_employeeGet fields of one employee by ID (0 means the API key's own user). You must list the field names wanted, e.g. firstName,lastName,jobTitle,department,workEmail,hireDate.

Input	Type		Description
`id`	string	Required	Employee ID, or 0 for the API key's own record
`fields`	string	Required	Comma-separated BambooHR field names, e.g. firstName,lastName,jobTitle,department,workEmail

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bamboohr.get_employee",
  input: {
    "id": "<id>",
    "fields": "<fields>"
  },
});

List time off requestsreadbamboohr.list_time_off_requestsList time off requests overlapping a date window (start and end together), optionally for one employee or status. Empty can also mean the key cannot see that employee.

Input	Type		Description
`start`	string	Required	Window start, YYYY-MM-DD
`end`	string	Required	Window end, YYYY-MM-DD
`status`	string	Optional	Request status
`employee_id`	integer	Optional	Only requests of this employee ID
`type`	string	Optional	Time off type ID

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bamboohr.list_time_off_requests",
  input: {
    "start": "<start>",
    "end": "<end>"
  },
});

List time off typesreadbamboohr.list_time_off_typesList the company's time off types (vacation, sick leave, ...) with their IDs, which time off requests refer to.

Input	Type		Description
`mode`	string	Optional	Use 'request' to return only types employees can request

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bamboohr.list_time_off_types",
  input: {},
});

Who is outreadbamboohr.whos_outList employees who are out (time off) and company holidays in a period. Defaults to today through 14 days ahead.

Input	Type		Description
`start`	string	Optional	Period start, YYYY-MM-DD
`end`	string	Optional	Period end, YYYY-MM-DD

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bamboohr.whos_out",
  input: {},
});