Bamboo Hr

Node: bambooHr · Full type: n8n-nodes-base.bambooHr · Version: 1

Credentials

bambooHrApi (alias: @bamboo)

CREDENTIAL @bamboo = bambooHrApi "My Bamboo Hr"

Operations

Resource: companyReport

get

Parameter	Type	Default	Details
reportId	string	""	required
format	options	"JSON"	required; CSV, JSON, PDF, XLS, XML
output	string	"data"	required
options	collection	{}	keys: fd, onlyCurrent

Resource: employee

create

Parameter	Type	Default	Details
synced	boolean	false	required
firstName	string	""	required
lastName	string	""	required
address	fixedCollection	{}	required; groups: value
dateOfBirth	dateTime	""	required
department	options	""	required
division	options	""	required
employeeNumber	string	""	required
exempt	options	""	required; exempt, non-exempt
gender	options	""	required; female, male
hireDate	dateTime	""	required
location	options	""	required
maritalStatus	options	""	required; single, married, domesticPartnership
mobilePhone	string	""	required
paidPer	options	""	required; hour, day, week, month, quater, year
payRate	fixedCollection	{}	required; groups: value
payType	options	""	required; commission, contract, daily, exceptionHourly, hourly, monthly, pieceRate, proRata, ... (10 total)
preferredName	string	""	required
ssn	string	""	required
additionalFields	collection	{}	keys: address, dateOfBirth, department, division, employeeNumber, exempt, ...

get

Parameter	Type	Default	Details
employeeId	string	""	required
options	collection	{}	keys: fields

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	5

update

Parameter	Type	Default	Details
employeeId	string	""	required
synced	boolean	false	required
addasasress	fixedCollection	{}	required; groups: value
dateOfBirth	dateTime	""	required
department	options	""	required
division	options	""	required
employeeNumber	string	""	required
firstName	string	""	required
lastName	string	""	required
exempt	options	""	required; exempt, non-exempt
gender	options	""	required; female, male
hireDate	dateTime	""	required
location	options	""	required
maritalStatus	options	""	required; single, married, domesticPartnership
mobilePhone	string	""	required
paidPer	options	""	required; hour, day, week, month, quater, year
payRate	fixedCollection	{}	required; groups: value
payType	options	""	required; commission, contract, daily, exceptionHourly, hourly, monthly, pieceRate, proRata, ... (10 total)
preferredName	string	""	required
ssn	string	""	required
updateFields	collection	{}	keys: addasasress, dateOfBirth, department, division, employeeNumber, firstName, ...

Resource: employeeDocument

delete

Parameter	Type	Default	Details
employeeId	string	""	required
fileId	string	""	required

download

Parameter	Type	Default	Details
employeeId	string	""	required
fileId	string	""	required
output	string	"data"	required

getAll

Parameter	Type	Default	Details
employeeId	string	""	required
returnAll	boolean	false
limit	number	5
simplifyOutput	boolean	true

update

Parameter	Type	Default	Details
employeeId	string	""	required
fileId	string	""	required
updateFields	collection	{}	keys: categoryId, name, shareWithEmployee

upload

Parameter	Type	Default	Details
employeeId	string	""	required
categoryId	string	""	required
binaryPropertyName	string	"data"	required
options	collection	{}	keys: share

Resource: file

delete

Parameter	Type	Default	Details
fileId	string	""	required

download

Parameter	Type	Default	Details
fileId	string	""	required
output	string	"data"	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	5
simplifyOutput	boolean	true

update

Parameter	Type	Default	Details
fileId	string	""	required
updateFields	collection	{}	keys: categoryId, name, shareWithEmployee

upload

Parameter	Type	Default	Details
binaryPropertyName	string	"data"	required
categoryId	options	""	required
options	collection	{}	keys: share

Parameter Details

address children:

value group:

Parameter	Type	Default	Details
address1	string	""
address2	string	""
city	string	""
state	string	""
country	string	""

payRate children:

value group:

Parameter	Type	Default	Details
value	string	""
currency	string	""

additionalFields children:

Parameter	Type	Default	Details
address	fixedCollection	{}	groups: value
dateOfBirth	dateTime	""
department	options	""
division	options	""
employeeNumber	string	""
exempt	options	""	exempt, non-exempt
gender	options	""	female, male
hireDate	dateTime	""
location	options	""
maritalStatus	options	""	single, married, domesticPartnership
mobilePhone	string	""
paidPer	options	""	hour, day, week, month, quater, year
payRate	fixedCollection	{}	groups: value
payType	options	""	commission, contract, daily, exceptionHourly, hourly, monthly, pieceRate, proRata, ... (10 total)
preferredName	string	""
ssn	string	""
workEmail	string	""
workPhone	string	""

options children:

Parameter	Type	Default	Details
fields	multiOptions	[...]

addasasress children:

value group:

Parameter	Type	Default	Details
address1	string	""
address2	string	""
city	string	""
state	string	""
country	string	""

updateFields children:

Parameter	Type	Default	Details
addasasress	fixedCollection	{}	groups: value
dateOfBirth	dateTime	""
department	options	""
division	options	""
employeeNumber	string	""
firstName	string	""
lastName	string	""
exempt	options	""	exempt, non-exempt
gender	options	""	female, male
hireDate	dateTime	""
location	options	""
maritalStatus	options	""	single, married, domesticPartnership
mobilePhone	string	""
paidPer	options	""	hour, day, week, month, quater, year
payRate	fixedCollection	{}	groups: value
payType	options	""	commission, contract, daily, exceptionHourly, hourly, monthly, pieceRate, proRata, ... (10 total)
preferredName	string	""
ssn	string	""
workEmail	string	""
workPhone	string	""

Example

NODE "bambooHr" @bamboo AS "Bamboo Hr" {
  resource: "companyReport",
  operation: "get",
  firstName: {{ $json.firstName }},
  lastName: {{ $json.lastName }},
  employeeNumber: {{ $json.employeeNumber }}
}