BAbamboohr
Datasets
Public API

Get Fields from Dataset (v1.2)

Changed on

Returns a paginated list of field descriptors for the specified dataset. Each field includes its machine-readable name, human-readable label, parent section type and name, and entityName. Use the returned field name values in the fields array when querying data via "Get Data from Dataset (v2)". Use "List Datasets (v1.2)" to discover valid datasetName values. Pagination defaults to page 1 with 500 fields per page (maximum 1000). Out-of-range page numbers are clamped to the nearest valid page. Some datasets, especially employee, may return hundreds of fields. This endpoint does not support filtering by parent/entity/type; retrieve all pages and group client-side.

The employee dataset field names are fully qualified with their section prefix and differ from the field names used by list-employees and get-employee. Do not assume a field name from one endpoint works in the other.

For fields whose type is list, multilist, or another option-backed type, the field id can be matched to fieldId from list-list-fields to retrieve the account-level option list.

Note: Compared to "Get Fields from Dataset (v1)", this version returns RFC 7807 application/problem+json error responses and includes an X-Request-ID correlation header.

OAuth Scopes: report

get/api/v1_2/datasets/{datasetName}/fields

Request

Path parameters

datasetNamestring required

The name of the dataset to retrieve fields for. Use "List Datasets (v1.2)" to discover valid names.

Query parameters

pageinteger

The page number to retrieve. Defaults to 1.

page_sizeinteger

The number of records to retrieve per page. Defaults to 500. Maximum is 1000.

Response

Returns an object containing pagination metadata, the dataset name and label, and a fields array of field descriptors.

namestring

Machine-readable dataset identifier matching the requested datasetName.

labelstring

Human-readable display name for the dataset.

Example response

{
  "pagination": {
    "next_page": "https://{companyDomain}.bamboohr.com/api/v1/{endpointPath}?page=3&page_size=1",
    "prev_page": "https://{companyDomain}.bamboohr.com/api/v1/{endpointPath}?page=1&page_size=1"
  },
  "name": "employee",
  "label": "Employee",
  "fields": [
    {
      "name": "status",
      "label": "Status",
      "parentType": "page",
      "parentName": "Personal",
      "entityName": "personal"
    },
    {
      "name": "employeeNumber",
      "label": "Employee #",
      "parentType": "page",
      "parentName": "Personal",
      "entityName": "personal"
    }
  ]
}

Changes

  • 922fc15f43a7Revision changes
    • info

      api operation id get-fields-from-dataset-v1-2 removed and replaced with get-fields-from-dataset-v1_2