โ† API reference
Query / jobs

getShiftDefinition

Fetch a single shift definition by id, or null when no definition with that id exists in the caller's tenant. Requires shiftDefinition:read permission.

Arguments

TypeID (prefix "shd") of the shift definition to fetch.

Returns ShiftDefinitionState

Scalar fields at a glance

nameString!
startTimeString!
endTimeString!
activeDays[Int!]!
isOvernightBoolean!
โ†— View the complete ShiftDefinitionState type

Explore in a view

Production Floor
View exact SDL
"""
Fetch a single shift definition by id, or null when no definition with that id exists in the caller's tenant. Requires shiftDefinition:read permission.
"""
getShiftDefinition(
  """TypeID (prefix "shd") of the shift definition to fetch."""
  id: ShiftDefinitionID!
): ShiftDefinitionState @topic(names: ["jobs"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.