get_bench: Bamboo API get request wrapper

View source: R/get_bench.r

get_benchR Documentation

Bamboo API get request wrapper

Description

Submits a get request to retrieve the custom bench table for all employees

Usage

get_bench(user = NULL, password = NULL, employee_ids = c("all"),
  year = NULL, verbose = FALSE)

Arguments

user

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

password

Bamboo login password

employee_ids

an optional list; specifies the employees for which bench time is requested; defaults to c('all') which gets all employee bench time

year

integer; the year for which bench records are desired; optional, defaults to NULL

verbose

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

Value

tbl_df

Author(s)

Mark Druffel, mdruffel@propellerpdx.com

References

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

Examples

## Not run: 
user <- 'your_api_user'
password <- 'your_password'
bench <- get_bench(user=user,password=password)

## End(Not run)


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