Field Service Mobile Settings

Returns information about the Field Service mobile app settings assigned to the profile of the context user. This resource is available in REST API version 42.0 and later.

The Field Service mobile app for Android and iOS comes with a variety of customizable settings, including branding colors, geolocation accuracy, app extensions, and date picker display. You can assign unique configurations of those settings to user profiles for a customized Field Service mobile experience. For example, configure separate settings to address the mobile needs of contractors, technicians of varying levels, and service crew leaders.

The FieldServiceMobileSettings object represents a configuration of the mobile app settings. The assignment of a settings configuration to a user profile is stored in a child object, MobileSettingsAssignment. A FieldServiceMobileSettings record can also have zero or more child AppExtension records. The userSettings extension enables the return of user profile settings information.

Each user profile can be associated with only one FieldServiceMobileSettings record. If a user’s profile isn’t explicitly assigned a settings record, the profile uses the default settings.

This resource returns information about the FieldServiceMobileApp settings assigned to the profile of the user in the context of which the call is made. It is available in orgs where Field Service is enabled, and can be used for users who have one or more of the following:

Field Service Mobile permission set license
View Setup user permission
Customize Application user permission
System Administrator profile

This resource can also be executed in the context of an Experience Builder site user with the Field Service Mobile permission set license.

Syntax

URI: /services/data/vXX.X/sobjects/FieldServiceMobileSettings/userSettings

Formats: JSON, XML

HTTP Method: GET

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Parameters: None.

Response Body

A FieldServiceMobileSettings record contains the following properties. All string properties have a maximum length of 7 characters unless otherwise noted. For descriptions, see FieldServiceMobileSettings in the Salesforce Object Reference.

Field	Type	Description
`BgGeoLocationAccuracy`	Enum	Values: Medium, Coarse, VeryCoarse.
`BgGeoLocationMinUpdateFreqMins`	Integer
`BrandInvertedColor`	String
`ContrastInvertedColor`	String
`ContrastPrimaryColor`	String
`ContrastQuaternaryColor`	String
`ContrastQuinaryColor`	String
`ContrastSecondaryColor`	String
`ContrastTertiaryColor`	String
`DefaultListViewDeveloperName`	String	Maximum length: 255.
`FeedbackPrimaryColor`	String
`FeedbackSecondaryColor`	String
`FeedbackSelectedColor`	String
`FutureDaysInDatePicker`	Integer
`GeoLocationAccuracy`	Enum	Values: Fine, Medium, Coarse.
`GeoLocationMinUpdateFreqMins`	Integer
`Id`	String
`IsAssignmentNotification`	Boolean
`IsDefault`	Boolean
`IsDispatchNotification`	Boolean
`IsScheduleViewResourceAbsences`	Boolean	Available in API version 55.0 and later.
`IsSendLocationHistory`	Boolean
`IsShowEditFullRecord`	Boolean
`IsUseSalesforceMobileActions`	Boolean
`MetadataCacheTimeDays`	Integer
`NavbarBackgroundColor`	String
`NavbarInvertedColor`	String
`PastDaysInDatePicker`	Integer
`PrimaryBrandColor`	String
`RecordDataCacheTimeMins`	Integer
`SecondaryBrandColor`	String
`TimeIntervalSetupMins`	Enum	Values: 1, 5, 15, 20, 30, 60.
`UpdateScheduleTimeMins`	Integer

If any of the following is true, an error message is returned:

The user does not have access to FieldServiceMobileSettings
Field Service is not enabled in the org
An internal server error occurs

Example

Request:

GET

/services/data/v56.0/sobjects/FieldServiceMobileSettings/userSettings

Response:

1{
2  "attributes" : {
3    "type" : "FieldServiceMobileSettings",
4    "url" : "/services/data/v46.0/sobjects/FieldServiceMobileSettings/0MfRM0000000rpR0AQ"
5  },
6  "Id" : "0MfRM0000000rpR0AQ",
7  "IsDeleted" : false,
8  "DeveloperName" : "Field_Service_Mobile_Settings",
9  "Language" : "en_US",
10  "MasterLabel" : "Field Service Mobile Settings",
11  "CreatedDate" : "2019-02-17T05:20:47.000+0000",
12  "CreatedById" : "005RM000001hTsLYAU",
13  "LastModifiedDate" : "2019-03-22T22:48:17.000+0000",
14  "LastModifiedById" : "005RM000001k2kpYAA",
15  "SystemModstamp" : "2019-03-22T22:48:17.000+0000",
16  "NavbarBackgroundColor" : "#803ABE",
17  "BrandInvertedColor" : "#FFFFFF",
18  "FeedbackPrimaryColor" : "#C23934",
19  "FeedbackSecondaryColor" : "#13C4A3",
20  "PrimaryBrandColor" : "#803ABE",
21  "SecondaryBrandColor" : "#2A7AB0",
22  "ContrastPrimaryColor" : "#000000",
23  "ContrastSecondaryColor" : "#444444",
24  "ContrastTertiaryColor" : "#9FAAB5",
25  "ContrastQuaternaryColor" : "#E6E6EB",
26  "ContrastQuinaryColor" : "#EEEEEE",
27  "ContrastInvertedColor" : "#FFFFFF",
28  "IsScheduleViewResourceAbsences" : true,
29  "IsSendLocationHistory" : false,
30  "GeoLocationMinUpdateFreqMins" : 10,
31  "GeoLocationAccuracy" : "Medium",
32  "RecordDataCacheTimeMins" : 240,
33  "MetadataCacheTimeDays" : 7,
34  "UpdateScheduleTimeMins" : 30,
35  "IsShowEditFullRecord" : false,
36  "TimeIntervalSetupMins" : "15",
37  "DefaultListViewDeveloperName" : null,
38  "NavbarInvertedColor" : "#FFFFFF",
39  "FeedbackSelectedColor" : "#FFFFFF",
40  "FutureDaysInDatePicker" : 45,
41  "PastDaysInDatePicker" : 45,
42  "IsDefault" : true,
43  "BgGeoLocationMinUpdateFreqMins" : 60,
44  "BgGeoLocationAccuracy" : "Coarse",
45  "IsUseSalesforceMobileActions" : false,
46  "IsAssignmentNotification" : false,
47  "IsDispatchNotification" : true
48}