When I Work · Schema

ShiftBreak

Employee SchedulingWorkforce ManagementTime TrackingTime ClockShift ManagementAttendanceTeam MessagingHourly WorkersLabor ForecastingHuman ResourcesScheduling

Properties

Name Type Description
id integer The shift break id
timeId integer The time id associated with the break
creatorId integer The id of the user who created the break
type integer The type of break (1=paid, 2=unpaid)
length integer The break time rounded to the nearest minute
isPunched boolean If the break was punched
editedBy integer The id of the user who edited the break
start string The break start time
end string The break end time
roundedStartTime string The rounded start time. Will only be visible if rounding is enabled.
roundedEndTime string The rounded end time. Will only be visible if rounding is enabled.
roundedLength integer The break time rounded based on the roundedStartTime and roundedEndTime if punched. If not punched, rounded to the nearest minute increment when rounding is enabled.
isOrphaned boolean If the break begins after its associated time entry ends.
scheduledBreakId integer The scheduled break associated with this shift break, if it is a scheduled break. Otherwise `0`
View JSON Schema on GitHub

JSON Schema

when-i-work-shift-break-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/when-i-work/json-schema/when-i-work-shift-break-schema.json",
  "title": "ShiftBreak",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/when-i-work-shift-breaks-api-openapi.yml#/components/schemas/ShiftBreak",
  "type": "object",
  "required": [
    "id",
    "timeId",
    "creatorId",
    "type",
    "length",
    "isPunched"
  ],
  "properties": {
    "id": {
      "description": "The shift break id",
      "type": "integer"
    },
    "timeId": {
      "description": "The time id associated with the break",
      "type": "integer"
    },
    "creatorId": {
      "description": "The id of the user who created the break",
      "type": "integer"
    },
    "type": {
      "description": "The type of break (1=paid, 2=unpaid)",
      "type": "integer"
    },
    "length": {
      "description": "The break time rounded to the nearest minute",
      "type": "integer"
    },
    "isPunched": {
      "description": "If the break was punched",
      "type": "boolean"
    },
    "editedBy": {
      "description": "The id of the user who edited the break",
      "type": "integer"
    },
    "start": {
      "description": "The break start time",
      "type": "string",
      "format": "date-time"
    },
    "end": {
      "description": "The break end time",
      "type": "string",
      "format": "date-time"
    },
    "roundedStartTime": {
      "description": "The rounded start time. Will only be visible if rounding is enabled.",
      "type": "string",
      "format": "date-time"
    },
    "roundedEndTime": {
      "description": "The rounded end time. Will only be visible if rounding is enabled.",
      "type": "string",
      "format": "date-time"
    },
    "roundedLength": {
      "description": "The break time rounded based on the roundedStartTime and roundedEndTime if punched. If not punched, rounded to the nearest minute increment when rounding is enabled.",
      "type": "integer"
    },
    "isOrphaned": {
      "description": "If the break begins after its associated time entry ends.",
      "type": "boolean"
    },
    "scheduledBreakId": {
      "description": "The scheduled break associated with this shift break, if it is a scheduled break. Otherwise `0`",
      "type": "integer"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/when-i-work-shift-break"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.