• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
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

Query Parameters

Example code
Name Description
location_id
string

Filter the returned BreakType results to only those that are associated with the specified location.
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.
cursor
string

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

Response Fields
Name Description
break_types
BreakType [ ]

A page of BreakType results.
cursor
string

The value supplied in the subsequent request to fetch the next page of BreakType results.
errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/labor/break-types
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/labor/break-types?location_id=PAA1RJZZKXBFG&limit=2&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED \
  -H 'Square-Version: 2022-11-16' \
  -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"
}