List employee fields
bamboohr_list_fieldsList every employee field in BambooHR, including custom fields, to see IDs, aliases, types, and allowed access. Search by name to find specific fields.
Instructions
List every employee field in this BambooHR account, standard and custom, with id, name, API alias, type and an allowed flag. Only fields with allowed:true can be read by bamboohr_get_employee or bamboohr_employee_report; the rest (pay, bank, national id, date of birth, gender, home contact details) are refused by policy. Use search to find a field by name (e.g. 'shoe', 'hire'). Set includeOptions to see the allowed values of list fields.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Case-insensitive substring of the field name or alias. | |
| includeOptions | No | Attach the option list of list-type fields. Default false. |