Get Break Policy Suggestions

Uses an AI agent to analyze existing break policies and company context, then returns structured meal and rest break policy recommendations ready for form pre-fill.

OAuth Scopes: time_tracking:breaks

post/api/v1/time-tracking/break-policies/suggestions

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
- HTTP basic
- or OAuth 2
  Authorization code/authorize.php
  Token URL/token.php
  Scopestime_tracking:breaks
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/time-tracking/break-policies/suggestions/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

promptstring required

The user's request or question for break policy suggestions (e.g. "What policies do we need for our California employees?")

Response

Suggestions returned successfully

Changes

No recorded changes to this operation across all 2 revisions of this API.

Get Break Policy Suggestions

Request

Request body

Response 200OK

Changes

Response