You are viewing an old version of the API
List break types

Returns a paginated list of BreakType instances for a business

Required permissions TIMECARDS_SETTINGS_READ

Query Parameters

Name Description
location_id
string

Filter Break Types returned to only those that are associated with the specified location.

limit
integer

Maximum number of Break Types to return per page. Can range between 1 and 200. The default is the maximum at 200.

cursor
string

Pointer to the next page of Break Type results to fetch.

Response Fields

Name Description
break_types
Break​Type [ ]

A page of BreakType results.

cursor
string

Value supplied in the subsequent request to fetch the next next page of Break Type 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
curl https://connect.squareup.com/v2/labor/break-types \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
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"
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?