v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBGet Fields from Dataset (v1)
Deprecated. Use "Get Fields from Dataset (v1.2)" instead.
Returns a paginated list of field descriptors for the specified dataset. Each field includes its machine-readable name, human-readable label, parentType, parentName, and entityName. Use the returned field name values in the fields array when querying data via "Get Data from Dataset". Use "List Datasets (v1.2)" to discover valid dataset names.
Pagination defaults to page 1 with 500 fields per page (maximum 1000). Out-of-range page numbers are clamped to the nearest valid page. The next_page and prev_page links in the pagination object are absolute URLs.
Error responses (400, 403, 500) return plain-text bodies, not JSON.
OAuth Scopes: report
Path parameters
The machine-readable name of the dataset to retrieve fields for. Use "List Datasets (v1.2)" to discover valid names.
Query parameters
The page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1.
The number of field 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.
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"
}
]
}