Meal & Rest Breaks

Public API

Assign Employees to Break Policy

Assigns employees to a break policy. Adds the specified employees to the policy without removing existing assignments.

OAuth Scopes: time_tracking:breaks.write

post/api/v1/time-tracking/break-policies/{id}/assign

Request

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

Path parameters

idstring uuid required

The break policy ID.

Request body

employeeIdsinteger[] required

Array of internal employee IDs to assign to the break policy

Response

Employees successfully assigned to the break policy

Changes

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