Check Out of Shift

POST {{base_url}}/api/v3/shifts/{{SHIFT_ID}}/check_out

Required scope: shifts:write

Checks the runner out of an operator-owned shift. Requires admin credentials. The operation is idempotent: retrying it keeps the shift checked out.

Request body

{}

Examples

cURL

curl --request POST '${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000/check_out' \
  --header 'Content-Type: application/json' \
  --data '{}'

Node.js

const response = await fetch("${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000/check_out", {
  "method": "POST",
  "headers": {
    "Content-Type": "application/json"
  },
  "body": "{}"
})
const data = await response.json()

Python

import requests

response = requests.request(
    "POST",
    "${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000/check_out",
    headers={
  'Content-Type': 'application/json'
},
    data="{}",
)
response.raise_for_status()

Saved responses

200 200 — Checked out

{
  "type": "success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "checked_in": null
  }
}

404 404 — Shift not found or not owned

{
  "type": "error",
  "message": "Shift not found",
  "status": 404
}