<- Labor API

Labor API

All versions ->

List break types

GET

 /v2/labor/break-types

Returns a paginated list of BreakType instances for a business.

Permissions:TIMECARDS_SETTINGS_READ
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

location_id

string

Filter the returned BreakType results to only those that are associated with the specified location.

Link to section

limit

integer(32-bit)

The maximum number of BreakType results to return per page. The number can range between 1 and 200. The default is 200.

Link to section

cursor

string

A pointer to the next page of BreakType results to fetch.

Link to section

Response fields

Link to section

break_types

A page of BreakType results.

Link to section

cursor

string

The value supplied in the subsequent request to fetch the next page of BreakType results.

Link to section

errors

Any errors that occurred during the request.