7shifts · Schema

Shift

7shifts Shift resource.

RestaurantSchedulingWorkforce ManagementEmployee SchedulingTime TrackingHRISLabor

Properties

Name	Type	Description
id	integer
user_id	integer
location_id	integer
department_id	integer
role_id	integer
start	string	Start datetime of the shift. UTC in ISO8601 format.
end	string	End datetime of the shift. UTC in ISO8601 format.
hourly_wage	integer	The hourly wage for this shift, in cents.
draft	boolean	Publication status indicator.
open	boolean	Indicates an unassigned shift available for requests.
station	string
attendance_status	string
breaks	array
created	string
modified	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/7shifts/refs/heads/main/json-schema/7shifts-shift-schema.json",
  "title": "Shift",
  "type": "object",
  "description": "7shifts Shift resource.",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "user_id": {
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "location_id": {
      "type": "integer",
      "format": "int64"
    },
    "department_id": {
      "type": "integer",
      "format": "int64"
    },
    "role_id": {
      "type": "integer",
      "format": "int64"
    },
    "start": {
      "type": "string",
      "format": "date-time",
      "description": "Start datetime of the shift. UTC in ISO8601 format."
    },
    "end": {
      "type": "string",
      "format": "date-time",
      "description": "End datetime of the shift. UTC in ISO8601 format."
    },
    "hourly_wage": {
      "type": "integer",
      "description": "The hourly wage for this shift, in cents."
    },
    "draft": {
      "type": "boolean",
      "description": "Publication status indicator."
    },
    "open": {
      "type": "boolean",
      "description": "Indicates an unassigned shift available for requests."
    },
    "station": {
      "type": "string",
      "nullable": true
    },
    "attendance_status": {
      "type": "string",
      "enum": [
        "none",
        "sick",
        "no_show",
        "late"
      ]
    },
    "breaks": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "modified": {
      "type": "string",
      "format": "date-time"
    }
  }
}