BAbamboohr
Custom Fields
Public API

List Custom Field List Values

Changed on

Returns the dropdown options (and employee counts) for a list-type custom field.

OAuth Scopes: employee:custom_fields

get/api/v1/hris/custom-fields/{customFieldId}/list-values

Request

Path parameters

customFieldIdstring required
Example:123

The ID of the custom field.

Response

Custom field list values and counts.

idstring

The string custom field ID.

legacyIdinteger

The legacy numeric custom field ID.

namestring

The custom field name.

typestring

The custom field type.

isEncryptedboolean

Whether the custom field is encrypted.

isCalculatedboolean

Whether the custom field is calculated.

isRequiredboolean

Whether the custom field is required.

summarizestring

The custom field summary setting.

Changes