Shift

Represents a shift for service resource scheduling. Available in API versions 46.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), upsert()

Special Access Rules

Field Service, Service Engagement, or Workforce Engagement must be enabled. For Field Service, users must have Field Service permissions. For Service Engagement, users must have the Service Engagement Planner permission set. For Workforce Engagement, users must have the Workforce Engagement Admin or Planner permission set.

Fields

Field	Details
BackgroundColor	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Sets a background color when shifts are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF. Available in API version 54.0 and later.
EndLocation	Type location Properties Nillable Description Captures the user’s geolocation at the end of the shift. This field is reserved for future use.
EndTime	Type dateTime Properties Create, Filter, Sort, Update Description The date and time that the shift ends.
GeoFnLcTypeAtShftEnd	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the allowed location type for geofence validation at the end of the shift. Possible values are: `First Customer` `Home` `Warehouse` This field is reserved for future use.
GeoFnLcTypeAtShftStart	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the allowed location type for geofence validation at the start of the shift. Possible values are: `First Customer` `Home` `Warehouse` This field is reserved for future use.
GeoFnNotificationType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the notification type for geofence validation at the start and end of the shift. Possible values are: `Error` `Warning` This field is reserved for future use.
IsGeoFnRqrAtShftEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether geofencing was enabled at the end of the shift. The default value is `false`. This field is reserved for future use.
IsGeoFnRqrAtShftStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether geofencing was enabled at the start of the shift. The default value is `false`. This field is reserved for future use.
IsGeoLcRqrAtShftEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether user's geolocation was captured at the end of the shift. The default value is `false`. This field is reserved for future use.
IsGeoLcRqrAtShftStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether user's geolocation was captured at the start of the shift. The default value is `false`. This field is reserved for future use.
IsHolidayShift	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates a shift that overlaps with holiday hours. The default value is false. Available in API version 55.0 and later.
IsNonStandard	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift is nonstandard, such as overtime or on-call shifts. The default value is false. Available in API version 54.0 and later.
IsOsidGeoFnRngAtShftEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift was ended outside the allowed distance between the user's GPS location and the geofence end location (true) or not (false). The default value is `false`. This field is reserved for future use.
IsOsidGeoFnRngAtShftStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift was started outside the allowed distance between the user's GPS location and the geofence start location (true) or not (false). The default value is `false`. This field is reserved for future use.
JobProfileId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The job profile associated with the shift. Available in API versions 47.0 and later.
Label	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The label that a shift is given.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed a related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the current user last viewed this record.
NotificationTypeAtShftEnd	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the notification type for open tours at the end of the shift. Possible values are: `Error` `Warning` This field is reserved for future use.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the shift. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
RecordsetFilterCriteriaId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the recordset filter criteria selected for the shift. Available in API version 49.0 and later. This is a relationship field. Relationship Name RecordsetFilterCriteria Relationship Type Lookup Refers To RecordsetFilterCriteria
ServiceResourceId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service resource the shift belongs to. Available in API versions 47.0 and later. This is a relationship field. Relationship Name ServiceResource Relationship Type Lookup Refers To ServiceResource
ServiceTerritoryId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the service territory the shift belongs to. Available in API versions 47.0 and later. This is a relationship field. Relationship Name ServiceTerritory Relationship Type Lookup Refers To ServiceTerritory
ShiftNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The number automatically given to the shift upon creation.
ShiftTemplateId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The shift template ID, if the shift was created from a shift template. Available in API version 53.0 and later. This is a relationship field. Relationship Name ShiftTemplate Relationship Type Lookup Refers To ShiftTemplate
ShouldAutoEnd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift was automatically ended when the tour was completed. The default value is `false`. This field is reserved for future use.
ShouldAutoStart	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the shift was automatically started when the tour began. The default value is `false`. This field is reserved for future use.
StartLocation	Type location Properties Nillable Description Captures the user’s geolocation at the start of the shift. This field is reserved for future use.
StartTime	Type dateTime Properties Create, Filter, Sort, Update Description The date and time that the shift starts.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The current status of the shift. Possible values are: `Complete` `In Progress` `New` The default value is `New`. This field is a Dynamic Enum. The order of the picklist values depends on how the Admin configures them in Object Manager. This field is reserved for future use. This field is reserved for future use.
StatusCategory	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Specifies the status of the shift using static values. This field is derived from Status using the mapping defined in setup. Possible values are: `Complete` `In progress`—In Progress `New` This field is reserved for future use.
TimeSlotType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Type of time slot for the shift. The same setup values as the TimeSlot field in the OperatingHours object. Possible values are: `Normal` (default value) `Extended`
UserId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The user assigned to the shift. This field is a relationship field. Relationship Name User Refers To User This field is reserved for future use.

Usage

Scheduling and dispatching service resources using shift data is not supported in API version 46.0, and is a pilot feature in API version 47.0.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

ShiftChangeEvent (API version 54.0): Change events are available for the object.

ShiftFeed: Feed tracking is available for the object.
ShiftHistory: History is available for tracked fields of the object.
ShiftOwnerSharingRule: Sharing rules are available for the object.
ShiftShare: Sharing is available for the object.