You are viewing an old version of the API
Get shift

Returns a single Shift specified by id

Required permissions TIMECARDS_READ

Path Parameters

Name Description
id
string

Required

UUID for the Shift being retrieved.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

shift
Shift

The requested Shift.

Examples

You are viewing an old version of the API
GET /v2/labor/shifts/{id}
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/labor/shifts/{id} \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'
Response JSON
{
  "shift": {
    "id": "T35HMQSN89SV4",
    "employee_id": "D71KRMQof6cXGUW0aAv7",
    "location_id": "PAA1RJZZKXBFG",
    "timezone": "America/New_York",
    "start_at": "2019-02-23T18:00:00-05:00",
    "end_at": "2019-02-23T21:00:00-05:00",
    "wage": {
      "title": "Cashier",
      "hourly_rate": {
        "amount": 1457,
        "currency": "USD"
      }
    },
    "breaks": [
      {
        "id": "M9BBKEPQAQD2T",
        "start_at": "2019-02-23T19:00:00-05:00",
        "end_at": "2019-02-23T20:00:00-05:00",
        "break_type_id": "92EPDRQKJ5088",
        "name": "Lunch Break",
        "expected_duration": "PT1H",
        "is_paid": true
      }
    ],
    "status": "CLOSED",
    "version": 1,
    "created_at": "2019-02-27T00:12:12Z",
    "updated_at": "2019-02-27T00:12:12Z"
  }
}

Share Feedback

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