BAbamboohr
Field Metadata
Public API

List Fields

Changed on

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

get/api/v1/meta/fields

Request

Headers

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

This endpoint can produce either JSON or XML.

Response

A list of all available employee fields in the account.

namestring required

The display name of the field.

typestring required

The data type of the field (e.g., text, date, list, checkbox).

aliasstring

The API alias for the field. Only present when the field has an alias.

deprecatedboolean

Whether the field is deprecated and should no longer be used. Only present for deprecated fields.

Changes

  • 922fc15f43a7Revision changes
    • info

      the security scope employee was added to the endpoint's security scheme oauth

    • info

      the security scope field was removed from the endpoint's security scheme oauth

    • info

      api tag Field Metadata added

    • info

      api tag Account Information removed