---
title: "List Fields"
method: GET
path: "/api/v1/meta/fields"
tags: ["Account Information", "Public API"]
---

# List Fields

`GET /api/v1/meta/fields`

Returns a list of all employee fields available in the account, including field ID, display name, data type, and whether the field is deprecated. Use this endpoint to discover which field names are valid for use with the Get Employee, Datasets, and other field-based endpoints. The response includes standard BambooHR fields as well as any custom fields configured in the account.

OAuth Scopes: employee, field

## Headers

- `AcceptHeaderParameter` 'application/xml' | 'application/json'

## Response `200`

A list of all available employee fields in the account.

- object[]
  - `id` union, required — The field identifier. For subfields this is a dotted string (e.g., "4340.4"); for top-level fields it may be an integer.
    - string
    - integer
  - `name` string, required — The display name of the field.
  - `type` string, required — The data type of the field (e.g., text, date, list, checkbox).
  - `alias` string — The API alias for the field. Only present when the field has an alias.
  - `deprecated` boolean — Whether the field is deprecated and should no longer be used. Only present for deprecated fields.

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/revisions/19ebf391a399/schema)