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

# List List Fields

`GET /api/v1/meta/lists`

Returns details for all list fields in the account. Each list includes its field ID, alias, options, and whether it is manageable (editable). Lists with the `manageable` attribute set to `yes` can be modified via the PUT endpoint. Lists with the `multiple` attribute set to `yes` are fields that can have multiple values. Options with the `archived` attribute set to `yes` are soft-deleted and included so that historical data can reference the value — filter by `archived: no` to show only active options to end users.

OAuth Scopes: field

## Query parameters

- `format` 'json'

## Headers

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

## Response `200`

All list field details, including field IDs, option values, and manageability.

- ListFieldDetail[]
  - `id` integer — The list ID.
  - `fieldId` integer — The field ID.
  - `name` string — The display name of the list field.
  - `alias` string, nullable — The API alias for the list field.
  - `manageable` 'yes' | 'no' — Whether the list field options can be modified via the API.
  - `multiple` 'yes' | 'no' — Whether this field supports multiple values.
  - `options` ListFieldOption[] — The available options for this list field.
    - `id` integer — The option ID.
    - `name` string — The display value of the option. In XML format, this is the text content of the <option> element.
    - `archived` 'yes' | 'no' — Whether this option is archived. Archived options are preserved for historical data integrity and continue to appear in responses. Filter by archived: no to show only active options.
    - `createdDate` string, nullable — The date the option was created, in ISO 8601 format. Server-set on creation; not client-supplied.
    - `archivedDate` string, nullable — The date the option was archived, in ISO 8601 format. Server-set when archived is first set to yes; persists even if the option is later un-archived.
    - `manageable` 'yes' | 'no' — Whether this individual option can be modified via the API.
    - `frequency` string, nullable — The pay frequency for the option. Only present on pay-group list fields.

## Other responses

- `403` — The authenticated caller does not have permission to view employee 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)