List Break Policy Employees

Retrieves employees assigned to a specific break policy. If a policy has no assignments, returns HTTP 200 with an empty data array.

OAuth Scopes: time_tracking:breaks

get/api/v1/time-tracking/break-policies/{id}/employees

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/:id/employees/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

The break policy ID.

offsetinteger

The offset of items to retrieve

limitinteger

The maximum items to retrieve

A list of employees assigned to a break policy

{
  "meta": {
    "totalItems": 3,
    "offset": 2,
    "limit": 2
  }
}

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