Learn R Programming

bambooHR

{bambooHR} is an R wrapper for the bambooHR API. By supplying a company domain and an API access token, users can seamlessly make API requests through built-in R functions. Get employees, employee files, reports and tables, all from within R.

Installing and Loading {bambooHR}

To install the latest release from CRAN, run:

install.packages("bambooHR")

Alternatively to install latest version on GitHub, run:

remotes::install_github("https://github.com/MangoTheCat/bambooHR")

Finally, load the package:

library(bambooHR)

Authentication

In order to obtain an API key, you will need to login to bambooHR via an account with administrative privileges. Hit the user icon in the top-right and select ‘API Keys’. Next, enter a name for the API key in the API Key Name field and click Generate Key. Copy the key to clipboard.

Now run the config_setup() function, supplying your API key and the company domain, plus an optional filepath for where to store the config file.

config_setup(apikey = "API_KEY_12345", 
             companyname = "Ascent", 
             conffile = "./bbhr_config.json")

The package functions will now pull in your configuration information automatically.

get_employee()

Copy Link

Version

Install

install.packages('bambooHR')

Monthly Downloads

251

Version

0.1.1

License

MIT + file LICENSE

Maintainer

Tom Bowling

Last Published

October 25th, 2023

Functions in bambooHR (0.1.1)

get_timeoff_requests

Get Time Off Requests
get_timeoff_types

Get Time Off Types
get_whos_out

Get a list of Who's Out
get_employee_file

Retrieve An Employee File
get_report

Get Company Report
get_meta

Get Meta Information
get_employee

Get employee data by specifying a set of fields.
get_company_file

Retrieve A Company File.
bambooHR-package

bambooHR: A Wrapper to the 'BambooHR' API
build_url

Build URL Endpoints with Company Domain and API Version
config_setup

Create a JSON config file
response_view

View Data About a Response.
get_timeoff_policies

Get Time Off policies
use_config

Use Config File
get_table

Bamboo API get request wrapper for BambooHR tables
get_request

Bamboo HR API get request wrapper
ISO_8601

Coerce to ISO 8601
%>%

Pipe operator
date_formats

Check Date Format