DocumentationAPI Reference
API Reference

Create Break

post
https://{companyDomain}.bamboohr.com/api/v1/time-tracking/break-policies//breaks

Creates a new break and associates it with the specified break policy.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The break policy ID.

Body Params
string

The name of the break

uuid

The unique identifier of the break policy this break belongs to

boolean

Whether the break is paid

integer

Duration of the break in minutes

enum

When the break is available to be taken

Allowed:
float | null

Minimum hours that must be worked before the break can be taken

float | null

Maximum hours that can be worked before the break must be taken

string | null

Earliest time the break can be taken (HH:MM format)

string | null

Latest time the break can be taken (HH:MM format)

Responses

Updated 3 days ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago