Start a break on the open session

Any signed in user. Marks the caller’s open session as on break and files the reason given. A session already on break or closed is refused, and a caller without one cannot pause.

POST/api/v1/sessions/break/start

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

reasonstring

Responses

200

Break started

statusstringrequired

break_idstringrequired

started_atstringrequired

400

Already on break, or the session is closed

detailstringrequired

401

Not authenticated

detailstringrequired

404

No active session

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

reasonstring

Request

curl -X POST 'http://localhost:8000/api/v1/sessions/break/start' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/sessions/break/start", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"reason\": \"string\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/sessions/break/start",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"reason\": \"string\"\n}",
)

Response

{
  "status": "string",
  "break_id": "string",
  "started_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}