BAbamboohr
Field Metadata
Public API

List List Fields

Changed on

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

get/api/v1/meta/lists

Request

Query parameters

format'json'

Set to "json" to receive JSON output as an alternative to using the Accept header.

Headers

AcceptHeaderParameter'application/xml' | 'application/json'

This endpoint can produce either JSON or XML.

Response

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

idinteger

The list ID.

fieldIdinteger

The field ID.

namestring

The display name of the list field.

aliasstring 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.

Changes