---
title: "List Custom Field List Values"
method: GET
path: "/api/v1/hris/custom-fields/{customFieldId}/list-values"
tags: ["Custom Fields", "Public API"]
---

# List Custom Field List Values

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

## Request

- Base URL: `https://companySubDomain.bamboohr.com`
- URL: `https://companySubDomain.bamboohr.com/api/v1/hris/custom-fields/{customFieldId}/list-values`
- Auth: OAuth 2
  - Authorization code: `/authorize.php`
  - Token URL: `/token.php` scopes: `employee:custom_fields`
- TypeScript: <https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/hris/custom-fields/:customFieldId/list-values/get.ts> (a function with typed inputs; its response is checked against the schema)

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

OAuth Scopes: employee:custom_fields

## Path parameters

- `customFieldId` string, required

## Response `200`

Custom field list values and counts.

- PublicListValuesCustomFieldSettingsResponse
  - `id` string: The string custom field ID.
  - `legacyId` integer: The legacy numeric custom field ID.
  - `name` string: The custom field name.
  - `type` string: The custom field type.
  - `isEncrypted` boolean: Whether the custom field is encrypted.
  - `isCalculated` boolean: Whether the custom field is calculated.
  - `isRequired` boolean: Whether the custom field is required.
  - `summarize` string: The custom field summary setting.
  - `values` object[]: The list values and the number of employees using each value.
    - `id` string: The string list value ID.
    - `legacyId` integer: The legacy numeric list value ID.
    - `display` string: The list value display name.
    - `count` integer: The number of employees using the list value.

## Other responses

- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not found.
- `422`: Invalid custom field ID.
- `500`: Internal server error.

## Changes

- **2026-11-03** `922fc15f43a7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bamboohr/apis/bamboohr-api/changes/api/v1/hris/custom-fields/:customFieldId/list-values/get.md)

---

[API](https://skmtc.dev/bamboohr/apis/bamboohr-api.md) - [All operations](https://skmtc.dev/bamboohr/apis/bamboohr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboohr/apis/bamboohr-api/revisions/922fc15f43a7?raw)