Skip to main content

Preferences

GET Preferences for the current user

https://api.track.toggl.com/api/v9/me/preferences

Returns user preferences and alpha features. The list of alpha features contains a full list of feature codes (every feature that exists in database) and the enabled flag specifying if that feature should be enabled or disabled for the user.

curl  https://api.track.toggl.com/api/v9/me/preferences \
-H "Content-Type: application/json" \
-u <email>:<password>

Response

{
"alpha_features": {
"description": "will be omitted if empty",
"items": [
{
"alpha_feature_id": {
"type": "integer"
},
"code": {
"type": "string"
},
"deleted_at": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "this field is often queried in OR with user_alpha_features.enabled and aliased as enabled",
"type": "boolean"
}
}
]
},
"collapseDetailedReportEntries": {
"description": "will be omitted if empty",
"type": "boolean"
},
"collapseTimeEntries": {
"description": "will be omitted if empty",
"type": "boolean"
},
"date_format": {
"type": "string"
},
"displayDensity": {
"description": "will be omitted if empty",
"type": "string"
},
"distinctRates": {
"description": "will be omitted if empty",
"type": "string"
},
"duration_format": {
"type": "string"
},
"firstSeenBusinessPromo": {
"description": "will be omitted if empty",
"type": "integer"
},
"hide_keyboard_shortcut": {
"description": "will be omitted if empty",
"type": "boolean"
},
"manualEntryMode": {
"description": "will be omitted if empty",
"type": "string"
},
"manualMode": {
"description": "will be omitted if empty",
"type": "boolean"
},
"manualModeOverlaySeen": {
"description": "will be omitted if empty",
"type": "boolean"
},
"offlineMode": {
"description": "will be omitted if empty",
"type": "string"
},
"pg_time_zone_name": {
"type": "string"
},
"projectDashboardActivityMode": {
"description": "will be omitted if empty",
"type": "string"
},
"record_timeline": {
"type": "boolean"
},
"reportRounding": {
"description": "will be omitted if empty",
"type": "boolean"
},
"reportRoundingDirection": {
"description": "will be omitted if empty",
"type": "string"
},
"reportRoundingStepInMinutes": {
"description": "will be omitted if empty",
"type": "integer"
},
"reportsHideWeekends": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenFollowModal": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenFooterPopup": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenProjectDashboardOverlay": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenTogglButtonModal": {
"description": "will be omitted if empty",
"type": "boolean"
},
"send_product_emails": {
"type": "boolean"
},
"send_timer_notifications": {
"type": "boolean"
},
"send_weekly_report": {
"type": "boolean"
},
"showTimeInTitle": {
"description": "will be omitted if empty",
"type": "boolean"
},
"show_total_billable_hours": {
"description": "will be omitted if empty",
"type": "boolean"
},
"snowballReportRounding": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportAmounts": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportDistinctRates": {
"description": "will be omitted if empty",
"type": "boolean"
},
"summaryReportGrouping": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportSortAsc": {
"description": "will be omitted if empty",
"type": "boolean"
},
"summaryReportSortField": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportSubGrouping": {
"description": "will be omitted if empty",
"type": "string"
},
"timeofday_format": {
"type": "string"
},
"timerView": {
"description": "will be omitted if empty",
"type": "string"
},
"timerViewMobile": {
"description": "will be omitted if empty",
"type": "string"
},
"toSAcceptNeeded": {
"description": "ToSAcceptNeeded represents the trigger for new ToS accept dialog",
"type": "boolean"
},
"visibleFooter": {
"description": "will be omitted if empty",
"type": "string"
},
"webTimeEntryStarted": {
"description": "will be omitted if empty",
"type": "boolean"
},
"webTimeEntryStopped": {
"description": "will be omitted if empty",
"type": "boolean"
},
"weeklyReportGrouping": {
"description": "will be omitted if empty",
"type": "string"
},
"weeklyReportValueToShow": {
"description": "will be omitted if empty",
"type": "string"
}
}

GET Preferences for an specific client of the current user

https://api.track.toggl.com/api/v9/me/preferences/{client}

Returns user preferences and alpha features. The list of alpha features contains a full list of feature codes (every feature that exists in database) and the enabled flag specifying if that feature should be enabled or disabled for the user.

curl  https://api.track.toggl.com/api/v9/me/preferences/{client} \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
clientstringfalseClient type

Response

{
"alpha_features": {
"description": "will be omitted if empty",
"items": [
{
"alpha_feature_id": {
"type": "integer"
},
"code": {
"type": "string"
},
"deleted_at": {
"type": "string"
},
"description": {
"type": "string"
},
"enabled": {
"description": "this field is often queried in OR with user_alpha_features.enabled and aliased as enabled",
"type": "boolean"
}
}
]
},
"collapseDetailedReportEntries": {
"description": "will be omitted if empty",
"type": "boolean"
},
"collapseTimeEntries": {
"description": "will be omitted if empty",
"type": "boolean"
},
"date_format": {
"type": "string"
},
"displayDensity": {
"description": "will be omitted if empty",
"type": "string"
},
"distinctRates": {
"description": "will be omitted if empty",
"type": "string"
},
"duration_format": {
"type": "string"
},
"firstSeenBusinessPromo": {
"description": "will be omitted if empty",
"type": "integer"
},
"hide_keyboard_shortcut": {
"description": "will be omitted if empty",
"type": "boolean"
},
"manualEntryMode": {
"description": "will be omitted if empty",
"type": "string"
},
"manualMode": {
"description": "will be omitted if empty",
"type": "boolean"
},
"manualModeOverlaySeen": {
"description": "will be omitted if empty",
"type": "boolean"
},
"offlineMode": {
"description": "will be omitted if empty",
"type": "string"
},
"pg_time_zone_name": {
"type": "string"
},
"projectDashboardActivityMode": {
"description": "will be omitted if empty",
"type": "string"
},
"record_timeline": {
"type": "boolean"
},
"reportRounding": {
"description": "will be omitted if empty",
"type": "boolean"
},
"reportRoundingDirection": {
"description": "will be omitted if empty",
"type": "string"
},
"reportRoundingStepInMinutes": {
"description": "will be omitted if empty",
"type": "integer"
},
"reportsHideWeekends": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenFollowModal": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenFooterPopup": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenProjectDashboardOverlay": {
"description": "will be omitted if empty",
"type": "boolean"
},
"seenTogglButtonModal": {
"description": "will be omitted if empty",
"type": "boolean"
},
"send_product_emails": {
"type": "boolean"
},
"send_timer_notifications": {
"type": "boolean"
},
"send_weekly_report": {
"type": "boolean"
},
"showTimeInTitle": {
"description": "will be omitted if empty",
"type": "boolean"
},
"show_total_billable_hours": {
"description": "will be omitted if empty",
"type": "boolean"
},
"snowballReportRounding": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportAmounts": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportDistinctRates": {
"description": "will be omitted if empty",
"type": "boolean"
},
"summaryReportGrouping": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportSortAsc": {
"description": "will be omitted if empty",
"type": "boolean"
},
"summaryReportSortField": {
"description": "will be omitted if empty",
"type": "string"
},
"summaryReportSubGrouping": {
"description": "will be omitted if empty",
"type": "string"
},
"timeofday_format": {
"type": "string"
},
"timerView": {
"description": "will be omitted if empty",
"type": "string"
},
"timerViewMobile": {
"description": "will be omitted if empty",
"type": "string"
},
"toSAcceptNeeded": {
"description": "ToSAcceptNeeded represents the trigger for new ToS accept dialog",
"type": "boolean"
},
"visibleFooter": {
"description": "will be omitted if empty",
"type": "string"
},
"webTimeEntryStarted": {
"description": "will be omitted if empty",
"type": "boolean"
},
"webTimeEntryStopped": {
"description": "will be omitted if empty",
"type": "boolean"
},
"weeklyReportGrouping": {
"description": "will be omitted if empty",
"type": "string"
},
"weeklyReportValueToShow": {
"description": "will be omitted if empty",
"type": "string"
}
}

POST Update the preferences for an specific client of the current user

https://api.track.toggl.com/api/v9/me/preferences/{client}

With this endpoint, preferences can be modified and alpha features can be enabled or disabled.

curl -X POST https://api.track.toggl.com/api/v9/me/preferences/{client} \
-H "Content-Type: application/json" \
-d '{"alpha_features":[{"alpha_feature_id":"integer","code":"string","deleted_at":"string","description":"string","enabled":"boolean"}],"collapseDetailedReportEntries":"boolean","collapseTimeEntries":"boolean","date_format":"string","displayDensity":"string","distinctRates":"string","duration_format":"string","firstSeenBusinessPromo":"integer","hide_keyboard_shortcut":"boolean","manualEntryMode":"string","manualMode":"boolean","manualModeOverlaySeen":"boolean","offlineMode":"string","pg_time_zone_name":"string","projectDashboardActivityMode":"string","record_timeline":"boolean","reportRounding":"boolean","reportRoundingDirection":"string","reportRoundingStepInMinutes":"integer","reportsHideWeekends":"boolean","seenFollowModal":"boolean","seenFooterPopup":"boolean","seenProjectDashboardOverlay":"boolean","seenTogglButtonModal":"boolean","send_product_emails":"boolean","send_timer_notifications":"boolean","send_weekly_report":"boolean","showTimeInTitle":"boolean","show_total_billable_hours":"boolean","snowballReportRounding":"string","summaryReportAmounts":"string","summaryReportDistinctRates":"boolean","summaryReportGrouping":"string","summaryReportSortAsc":"boolean","summaryReportSortField":"string","summaryReportSubGrouping":"string","timeofday_format":"string","timerView":"string","timerViewMobile":"string","toSAcceptNeeded":"boolean","visibleFooter":"string","webTimeEntryStarted":"boolean","webTimeEntryStopped":"boolean","weeklyReportGrouping":"string","weeklyReportValueToShow":"string"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
clientstringfalseClient type

Body

nametypedescription
alpha_featuresArray of
nametypedescription
alpha_feature_idinteger-
codestring-
deleted_atstring-
descriptionstring-
enabledbooleanthis field is often queried in OR with user_alpha_features.enabled and aliased as enabled
will be omitted if empty
collapseDetailedReportEntriesbooleanwill be omitted if empty
collapseTimeEntriesbooleanwill be omitted if empty
date_formatstring-
displayDensitystringwill be omitted if empty
distinctRatesstringwill be omitted if empty
duration_formatstring-
firstSeenBusinessPromointegerwill be omitted if empty
hide_keyboard_shortcutbooleanwill be omitted if empty
manualEntryModestringwill be omitted if empty
manualModebooleanwill be omitted if empty
manualModeOverlaySeenbooleanwill be omitted if empty
offlineModestringwill be omitted if empty
pg_time_zone_namestring-
projectDashboardActivityModestringwill be omitted if empty
record_timelineboolean-
reportRoundingbooleanwill be omitted if empty
reportRoundingDirectionstringwill be omitted if empty
reportRoundingStepInMinutesintegerwill be omitted if empty
reportsHideWeekendsbooleanwill be omitted if empty
seenFollowModalbooleanwill be omitted if empty
seenFooterPopupbooleanwill be omitted if empty
seenProjectDashboardOverlaybooleanwill be omitted if empty
seenTogglButtonModalbooleanwill be omitted if empty
send_product_emailsboolean-
send_timer_notificationsboolean-
send_weekly_reportboolean-
showTimeInTitlebooleanwill be omitted if empty
show_total_billable_hoursbooleanwill be omitted if empty
snowballReportRoundingstringwill be omitted if empty
summaryReportAmountsstringwill be omitted if empty
summaryReportDistinctRatesbooleanwill be omitted if empty
summaryReportGroupingstringwill be omitted if empty
summaryReportSortAscbooleanwill be omitted if empty
summaryReportSortFieldstringwill be omitted if empty
summaryReportSubGroupingstringwill be omitted if empty
timeofday_formatstring-
timerViewstringwill be omitted if empty
timerViewMobilestringwill be omitted if empty
toSAcceptNeededbooleanToSAcceptNeeded represents the trigger for new ToS accept dialog
visibleFooterstringwill be omitted if empty
webTimeEntryStartedbooleanwill be omitted if empty
webTimeEntryStoppedbooleanwill be omitted if empty
weeklyReportGroupingstringwill be omitted if empty
weeklyReportValueToShowstringwill be omitted if empty

Response

Successful operation.

GET Get workspace preferences

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences

Get the preferences for a given workspace.

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Response

{
"logo": {
"type": "string"
}
}

POST Get workspace preferences

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences

Get the preferences for a given workspace.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/preferences \
-H "Content-Type: application/json" \
-d '{"annual-master-campaign-2018":"string","campaigns":{"additionalProperties":"-"},"inc_tos_accepted_at":"string","inc_tos_accepted_by":"integer","initial_pricing_plan":"integer","january-2018-campaign":"boolean","master_signup":"boolean","report_locked_at":"string","single_sign_on":"boolean","sso_requested_at":"string"}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

nametypedescription
annual-master-campaign-2018string-
campaigns
nametypedescription
additionalPropertiesobject-
-
inc_tos_accepted_atstring-
inc_tos_accepted_byinteger-
initial_pricing_planinteger-
january-2018-campaignbooleanShould be deprecated
master_signupbooleanbellow are the read-only fields:
report_locked_atstring-
single_sign_onboolean-
sso_requested_atstring-

Response

{
"logo": {
"type": "string"
}
}
© 2022 Toggl. All rights reserved.