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
| Name | Description |
|---|---|
location_id
|
Filter Break Types returned to only those that are associated with the specified location. |
limit
|
Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200. |
cursor
|
Pointer to the next page of Break Type results to fetch. |
Response Fields
| Name | Description |
|---|---|
break_types
|
A page of |
cursor
|
Value supplied in the subsequent request to fetch the next next page of Break Type results. |
errors
|
Any errors that occurred during the request. |
Examples
GET
/v2/labor/break-types
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/labor/break-types?location_id=PAA1RJZZKXBFG&limit=2&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED \
-H 'Square-Version: 2020-09-23' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{
"break_types": [
{
"id": "REGS1EQR1TPZ5",
"location_id": "PAA1RJZZKXBFG",
"break_name": "Coffee Break",
"expected_duration": "PT5M",
"is_paid": false,
"version": 1,
"created_at": "2019-01-22T20:47:37Z",
"updated_at": "2019-01-22T20:47:37Z"
},
{
"id": "92EPDRQKJ5088",
"location_id": "PAA1RJZZKXBFG",
"break_name": "Lunch Break",
"expected_duration": "PT1H",
"is_paid": true,
"version": 3,
"created_at": "2019-01-25T19:26:30Z",
"updated_at": "2019-01-25T19:26:30Z"
}
],
"cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED"
}