Get shift

GET

/v2/labor/shifts/{id}

Returns a single Shift specified by id.

Permissions:TIMECARDS_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

string

Required

The UUID for the Shift being retrieved.

Link to section

Response fields

Link to section

shift

The requested Shift.

Link to section

errors

Any errors that occurred during the request.

Link to section

Examples

GET /v2/labor/shifts/{id}

curl https://connect.squareup.com/v2/labor/shifts/T35HMQSN89SV4 \
  -H 'Square-Version: 2024-10-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "shift": {
    "id": "T35HMQSN89SV4",
    "team_member_id": "D71KRMQof6cXGUW0aAv7",
    "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"
      },
      "job_id": "N4YKVLzFj3oGtNocqoYHYpW3",
      "tip_eligible": true
    },
    "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
      }
    ],
    "declared_cash_tip_money": {
      "amount": 500,
      "currency": "USD"
    },
    "status": "CLOSED",
    "version": 1,
    "created_at": "2019-02-27T00:12:12Z",
    "updated_at": "2019-02-27T00:12:12Z"
  }
}