bambooHR (version 0.1.1)

get_table: Bamboo API get request wrapper for BambooHR tables

Description

Returns a data structure representing all the table rows for a given employee and table combination.

Usage

get_table(employee_id, table_name, api_version = "v1")

Value

A tibble::tibble() object.

Arguments

employee_id

Character of employee ID to return. A special employee ID of "all", can also be used which will cause the API to return all rows for all employees in the table. When specifying "all" employees, the result will include inactive and terminated employees. In addition, the special employee ID of 0 is the employee ID associated with the API key being used.

table_name

Character of table name. Valid table names can be found in the "parent_alias" column return by get_meta("tables").

api_version

(optional) - Version of API to use to make request. Default is "v1".

References

https://documentation.bamboohr.com/reference#get-employee-table-row-1

Examples

if (FALSE) {
get_table(employee_id = "all", table_name = "jobInfo")

get_table(employee_id = 0, table_name = "jobInfo")

get_table(0, "compensation")
}