The following Entities have configurable settings via API:

• accounts
• regions
• zones
• clients
• departments

These settings are read and write capable via the following methods.

[GET|PATCH] /rest/v1/{accounts|regions|zones|clients|departments}/{id}/settings/{setting_key}

Every Setting has its own key format that you’ll have to inspect (especially the Value property).

Patching Settings (e.g. Region Locale Date Format)

Settings Examples (not exhaustive)

Regions

[ { "tag": "TimeZone", "value": "America/New_York", "description": "The Timezone of the account", "category": "SYSTEM-LOCALE" }, { "tag": "DateFormat", "value": "m/d/Y", "description": "The locale date format.", "category": "SYSTEM-LOCALE" }, { "tag": "TimeFormat", "value": "h:ia", "description": "The locale time format.", "category": "SYSTEM-LOCALE" }, { "tag": "CurrencyFormat", "value": "$", "description": "The locale currency format.", "category": "SYSTEM-LOCALE" }, { "tag": "DistanceFormat", "value": "km", "description": "The locale distance format.", "category": "SYSTEM-LOCALE" }, { "tag": "AddressFormat", "value": "CA", "description": "The locale address format.", "category": "SYSTEM-LOCALE" }, { "tag": "AllowMultiCount", "value": true, "description": "Allow one patrol counting as more.", "category": "RUNSHEET" }, { "tag": "RunsheetAutoApproval", "value": "AUTO_APPROVE_ALL", "description": "Runsheet Job Auto Approval Strategy.", "category": "RUNSHEET" }, { "tag": "RunsheetGracePeriod", "value": "ALLOW_TASK_GRACE_PERIOD_YES", "description": "Allow runsheet task grace periods.", "category": "RUNSHEET" }, { "tag": "DispatchJobAutoApproval", "value": "AUTO_ALL", "description": "Dispatch Job Auto Approval Strategy.", "category": "DISPATCH" }, { "tag": "DispatchDisplayBillingNote", "value": false, "description": "Dispatch Job Billing Note Mandatory.", "category": "DISPATCH" }, { "tag": "DispatchSlaLogic", "value": "COUNT_AFTER_JOB_TIME", "description": "Dispatch SLA Logic.", "category": "DISPATCH" }, { "tag": "DispatchRefreshRate", "value": 30000, "description": "Active Dispatch Refresh Rate (in milliseconds).", "category": "DISPATCH" }, { "tag": "LateClockOutReminderAfter", "value": 0, "description": "Late Clock-Out Reminder after (in minutes)", "category": "SCHEDULING" }, { "tag": "EmergencyNumber", "value": 911, "description": "Emergency Number (911)", "category": "PATROL-AND-SECURITY" } ]

Clients

[ { "tag": "TimeZone", "value": "America/New_York", "description": "The Timezone of the account", "category": "SYSTEM-LOCALE" }, { "tag": "PatrolTourReportDetails", "value": true, "description": "Include Patrol Tour Report Details?", "category": "REPORT" }, { "tag": "DisplayGpsCoordinates", "value": false, "description": "Display GPS Coordinates on Patrol Tour Report Details?", "category": "REPORT" }, { "tag": "DualBranding", "value": false, "description": "If the account has dual branding enabled", "category": "REPORT" }, { "tag": "CheckpointActionRequired", "value": false, "description": "Checkpoint Actions required to be consider scanned?", "category": "REPORT" } ]

2024-02-21 Full List

These are lifted from a code sources directory tree and don’t reflect the “category” names:

Dispatch\DispatchSetting
Dispatch\DisplayBillingNoteSetting
Dispatch\JobAutoApprovalSetting
Dispatch\RefreshRateSetting
Dispatch\SlaSettingLogicSetting

Locale\AddressFormatSetting
Locale\CurrencyFormatSetting
Locale\DateFormatSetting
Locale\DistanceFormatSetting
Locale\LocaleSetting
Locale\TimeFormatSetting
Locale\TimeZoneSetting

LoneWorker\LateAfterSetting
LoneWorker\LateBeforeSetting
LoneWorker\LoneWorkerSetting

PatrolAndSecurity\EmergencyNumber
PatrolAndSecurity\PatrolAndSecuritySetting

Report\CheckpointActionRequired
Report\ClientReportSettings
Report\DisplayGpsCoordinates
Report\DualBrandingSetting
Report\PatrolTourReportDetails

Runsheet\AllowMultiCountSetting
Runsheet\DisplaySiteInfoOnPaperSetting
Runsheet\RunsheetAutoApprovalSetting
Runsheet\RunsheetGracePeriodSetting
Runsheet\RunsheetSetting

Scheduling\LateClockOutReminderAfter
Scheduling\SchedulingSetting