get_employee_data: Bamboo API get request wrapper

View source: R/get_employee_data.R

get_employee_dataR Documentation

Bamboo API get request wrapper

Description

Submits a get request to retrieve the given fields for the given employees

Usage

get_employee_data(ids = NULL, fields = c("firstName", "lastName",
  "jobTitle", "terminationDate", "hireDate", "location"), user = NULL,
  password = NULL, verbose = FALSE)

Arguments

ids

data frame or list of Bamboo Employee IDs

fields

Bamboo fields to be requested, can be requested by id or alias outlined in get_bamboo_meta_fields

user

Bamboo api user id, register in Bamboo "API Keys"

password

Bamboo login password

verbose

a logical; indicates if detailed output from httr calls should be provided; default FALSE

Value

tbl_df

Author(s)

Evan Downey, edowney@propellerpdx.com

References

https://www.bamboohr.com/api/documentation/, https://github.com/r-lib/httr

Examples


ids <- data.frame(id=c(1,6,16,24,44))
fields <- c("firstName","hireDate","location","terminationDate","lastChanged")
user <- 'your_api_user'
password <- 'your_password'
employee_data <- get_employee_data(ids=ids, fields = fields, user=user, password=password)


propellerpdx/bambooR documentation built on July 8, 2023, 4:43 a.m.