Okapi Okapi

BambooHR API GET /api/v1/datasets/{id}/fields endpoint removal

Deprecated, no dateSubscribe to BambooHR APIShare

BambooHR API deprecated the GET /api/v1/datasets/{id}/fields endpoint without a shutdown date. Calls made to this route are slated for removal and will eventually fail. The change was announced on March 25, 2026, marking the endpoint as deprecated in the API documentation.


Calls it hits

  • GET /api/v1/datasets/{id}/fields

What to use instead of these calls

Use GET /api/v1_2/datasets/{datasetName}/fields instead.

In BambooHR API's words

We marked the following Dataset discovery endpoints as deprecated in our OpenAPI documentation and added guidance directing consumers to the v1.2 versions: - GET /api/v1/datasets → GET /api/v1_2/datasets - GET /api/v1/datasets/{datasetName}/fields → GET /api/v1_2/datasets/{datasetName}/fields - POST /api/v1/datasets/{datasetName}/field-options → POST /api/v1_2/datasets/{datasetName}/field-options

BambooHR API, Announcement

Facts

API
BambooHR API *.bamboohr.com
Kind
Endpoint removal
Announced
March 25, 2026
Takes effect
No date given yet
Calls after that day
Fail
Source
Announcement
Last updated
Verified
, against BambooHR API's own pages

Questions

When does this change take effect?

BambooHR API deprecated GET /api/v1/datasets/{id}/fields without giving a shutdown date yet.

Do these calls still work?

Yes, they still work: BambooHR API has not given a shutdown date yet.

How do I find the calls this hits in my code?

Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.


More from BambooHR API 10

  1. No date GET /api/v1/datasetsEndpoint removal Deprecated, no date
  2. No date GET /api/v1/employees/{id}/time_off/policiesEndpoint removal Deprecated, no date
  3. No date GET /api/v1/performance/employees/{id}/goals/aggregateEndpoint removal Deprecated, no date
  4. No date GET /api/v1/reports/{id}Endpoint removal Deprecated, no date
  5. No date POST /api/v1/datasets/{id}Endpoint removal Deprecated, no date
  6. No date POST /api/v1/datasets/{id}/field-optionsEndpoint removal Deprecated, no date
  7. No date POST /api/v1/employees/{id}/tables/{id}Endpoint removal Deprecated, no date
  8. No date POST /api/v1/employees/{id}/tables/{id}/{id}Endpoint removal Deprecated, no date
  9. No date POST /api/v1/loginEndpoint removal Deprecated, no date
  10. No date POST /api/v1/reports/customEndpoint removal Deprecated, no date

Is your code calling this?

Okapi finds the calls this change hits in your repo and opens the pull request with the fix.

Add to GitHub

Get notifications

Subscribe to BambooHR API

Hear about each breaking change BambooHR API announces, in your feed reader, calendar or Slack.

1What to follow

Provider
  • BambooHR API

2Where to get it

/breaking-changes/feed.xml

Paste it into Feedly, Inoreader, NetNewsWire or any reader. New changes show up as they're announced.