{"slug":"bamboohr-api","name":"BambooHR API","host":"*.bamboohr.com","site":"https://bamboohr.com","category":"productivity","docsUrl":null,"sources":[{"kind":"changelog","url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api"},{"kind":"openapi","url":"https://openapi.bamboohr.io/main/latest/docs/openapi/public-openapi.yaml"}],"url":"https://www.okapi.bot/providers/bamboohr-api/","json":"https://www.okapi.bot/api/v1/providers/bamboohr-api.json","breakingChanges":[{"slug":"get-api-v1-datasets-is-deprecated","api":"bamboohr-api","title":"GET /api/v1/datasets is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-25","effectiveAt":null,"scope":null,"calls":["GET /api/v1/datasets"],"method":"GET","path":"/api/v1/datasets","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"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","migration":"Use GET /api/v1_2/datasets.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/get-api-v1-datasets-is-deprecated/"},{"slug":"get-api-v1-datasets-fields-is-deprecated","api":"bamboohr-api","title":"GET /api/v1/datasets/{}/fields is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-25","effectiveAt":null,"scope":null,"calls":["GET /api/v1/datasets/{}/fields"],"method":"GET","path":"/api/v1/datasets/{}/fields","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"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","migration":"Use GET /api/v1_2/datasets/{datasetName}/fields.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/get-api-v1-datasets-fields-is-deprecated/"},{"slug":"get-api-v1-employees-time-off-policies-is-deprecated","api":"bamboohr-api","title":"GET /api/v1/employees/{}/time_off/policies is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-08","effectiveAt":null,"scope":null,"calls":["GET /api/v1/employees/{}/time_off/policies"],"method":"GET","path":"/api/v1/employees/{}/time_off/policies","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked the following v1 endpoints as deprecated in our OpenAPI documentation and added guidance directing new development to their v1.1 equivalents: - POST /api/v1/employees/{id}/tables/{table} - POST /api/v1/employees/{id}/tables/{table}/{rowId} - GET /api/v1/employees/{employeeId}/time_off/policies - PUT /api/v1/employees/{employeeId}/time_off/policies","migration":"Use GET /api/v1_1/employees/{employeeId}/time_off/policies.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/get-api-v1-employees-time-off-policies-is-deprecated/"},{"slug":"get-api-v1-performance-employees-goals-aggregate-is-deprecated","api":"bamboohr-api","title":"GET /api/v1/performance/employees/{}/goals/aggregate is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-04-03","effectiveAt":null,"scope":null,"calls":["GET /api/v1/performance/employees/{}/goals/aggregate"],"method":"GET","path":"/api/v1/performance/employees/{}/goals/aggregate","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked GET /api/v1/performance/employees/{employeeId}/goals/aggregate as deprecated in our OpenAPI documentation.","migration":"Use GET /api/v1_2/performance/employees/{employeeId}/goals/aggregate.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/get-api-v1-performance-employees-goals-aggregate-is-deprecated/"},{"slug":"get-api-v1-reports-is-deprecated","api":"bamboohr-api","title":"GET /api/v1/reports/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-18","effectiveAt":null,"scope":null,"calls":["GET /api/v1/reports/{}"],"method":"GET","path":"/api/v1/reports/{}","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked two legacy report endpoints as deprecated in our OpenAPI documentation and added guidance directing consumers to their newer alternatives: - POST /api/v1/reports/custom → Get Data from Dataset v2 at POST /api/v2/datasets/{datasetName}/data - GET /api/v1/reports/{id} → Get Report by ID at GET /api/v1/custom-reports/{reportId}","migration":"Use Get Report by ID, GET /api/v1/custom-reports/{reportId}; GET /api/v1/custom-reports/legacy-id-map and legacy-field-map map the old ids and fields.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/get-api-v1-reports-is-deprecated/"},{"slug":"post-api-v1-datasets-is-deprecated","api":"bamboohr-api","title":"POST /api/v1/datasets/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-04-09","effectiveAt":null,"scope":null,"calls":["POST /api/v1/datasets/{}"],"method":"POST","path":"/api/v1/datasets/{}","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked POST /api/v1/datasets/{datasetName} as deprecated in our OpenAPI documentation and added guidance to use Get Data from Dataset v2: POST /api/v2/datasets/{datasetName}/data","migration":"Use POST /api/v2/datasets/{datasetName}/data (Get Data from Dataset v2).","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-datasets-is-deprecated/"},{"slug":"post-api-v1-datasets-field-options-is-deprecated","api":"bamboohr-api","title":"POST /api/v1/datasets/{}/field-options is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-25","effectiveAt":null,"scope":null,"calls":["POST /api/v1/datasets/{}/field-options"],"method":"POST","path":"/api/v1/datasets/{}/field-options","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"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","migration":"Use POST /api/v1_2/datasets/{datasetName}/field-options.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-datasets-field-options-is-deprecated/"},{"slug":"post-api-v1-employees-tables-is-deprecated","api":"bamboohr-api","title":"POST /api/v1/employees/{}/tables/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-08","effectiveAt":null,"scope":null,"calls":["POST /api/v1/employees/{}/tables/{}"],"method":"POST","path":"/api/v1/employees/{}/tables/{}","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked the following v1 endpoints as deprecated in our OpenAPI documentation and added guidance directing new development to their v1.1 equivalents: - POST /api/v1/employees/{id}/tables/{table} - POST /api/v1/employees/{id}/tables/{table}/{rowId} - GET /api/v1/employees/{employeeId}/time_off/policies - PUT /api/v1/employees/{employeeId}/time_off/policies","migration":"Use POST /api/v1_1/employees/{id}/tables/{table}.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-employees-tables-is-deprecated/"},{"slug":"post-api-v1-employees-tables-is-deprecated-2","api":"bamboohr-api","title":"POST /api/v1/employees/{}/tables/{}/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-08","effectiveAt":null,"scope":null,"calls":["POST /api/v1/employees/{}/tables/{}/{}"],"method":"POST","path":"/api/v1/employees/{}/tables/{}/{}","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked the following v1 endpoints as deprecated in our OpenAPI documentation and added guidance directing new development to their v1.1 equivalents: - POST /api/v1/employees/{id}/tables/{table} - POST /api/v1/employees/{id}/tables/{table}/{rowId} - GET /api/v1/employees/{employeeId}/time_off/policies - PUT /api/v1/employees/{employeeId}/time_off/policies","migration":"Use POST /api/v1_1/employees/{id}/tables/{table}/{rowId}.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-employees-tables-is-deprecated-2/"},{"slug":"post-api-v1-login-is-deprecated","api":"bamboohr-api","title":"POST /api/v1/login is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-05-12","effectiveAt":null,"scope":null,"calls":["POST /api/v1/login"],"method":"POST","path":"/api/v1/login","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked POST /api/v1/login as deprecated in our OpenAPI documentation and added guidance recommending OAuth 2.0 for new integrations.","migration":"Authenticate with OAuth 2.0 (an app registered on developers.bamboohr.com, authorize.php and token.php on the company's domain) instead of generating API keys through /api/v1/login.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-login-is-deprecated/"},{"slug":"post-api-v1-reports-custom-is-deprecated","api":"bamboohr-api","title":"POST /api/v1/reports/custom is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-18","effectiveAt":null,"scope":null,"calls":["POST /api/v1/reports/custom"],"method":"POST","path":"/api/v1/reports/custom","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked two legacy report endpoints as deprecated in our OpenAPI documentation and added guidance directing consumers to their newer alternatives: - POST /api/v1/reports/custom → Get Data from Dataset v2 at POST /api/v2/datasets/{datasetName}/data - GET /api/v1/reports/{id} → Get Report by ID at GET /api/v1/custom-reports/{reportId}","migration":"Use Get Data from Dataset v2, POST /api/v2/datasets/{datasetName}/data; GET /api/v1/custom-reports/legacy-field-map maps the old field identifiers.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-reports-custom-is-deprecated/"},{"slug":"post-api-v1-time-tracking-projects-is-deprecated","api":"bamboohr-api","title":"POST /api/v1/time_tracking/projects is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-30","effectiveAt":null,"scope":null,"calls":["POST /api/v1/time_tracking/projects"],"method":"POST","path":"/api/v1/time_tracking/projects","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked the legacy Create Time Tracking Project endpoint as deprecated in our OpenAPI documentation: POST /api/v1/time_tracking/projects","migration":"Use POST /api/v1/time-tracking/projects (hyphen, not underscore), the current Create Time Tracking Project endpoint.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/post-api-v1-time-tracking-projects-is-deprecated/"},{"slug":"put-api-v1-employees-time-off-policies-is-deprecated","api":"bamboohr-api","title":"PUT /api/v1/employees/{}/time_off/policies is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-08","effectiveAt":null,"scope":null,"calls":["PUT /api/v1/employees/{}/time_off/policies"],"method":"PUT","path":"/api/v1/employees/{}/time_off/policies","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked the following v1 endpoints as deprecated in our OpenAPI documentation and added guidance directing new development to their v1.1 equivalents: - POST /api/v1/employees/{id}/tables/{table} - POST /api/v1/employees/{id}/tables/{table}/{rowId} - GET /api/v1/employees/{employeeId}/time_off/policies - PUT /api/v1/employees/{employeeId}/time_off/policies","migration":"Use PUT /api/v1_1/employees/{employeeId}/time_off/policies.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/put-api-v1-employees-time-off-policies-is-deprecated/"},{"slug":"put-api-v1-time-off-requests-status-is-deprecated","api":"bamboohr-api","title":"PUT /api/v1/time_off/requests/{}/status is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-08-17","effectiveAt":null,"scope":null,"calls":["PUT /api/v1/time_off/requests/{}/status"],"method":"PUT","path":"/api/v1/time_off/requests/{}/status","source":{"url":"https://documentation.bamboohr.com/docs/past-changes-to-the-api","kind":"archive"},"quote":"We marked the following endpoint as deprecated in our OpenAPI documentation and added guidance directing consumers to the newer process resources: PUT /api/v1/time_off/requests/{requestId}/status","migration":"Use POST /api/v1/time-off/requests/{id}/approvals, /denials or /cancellations instead of setting the status.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:03:49.361Z","updatedAt":"2026-10-23T10:03:49.361Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/bamboohr-api/breaking-changes/put-api-v1-time-off-requests-status-is-deprecated/"}]}