User-workspace-settings

GET Get user workspace settings

https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings

Returns merged user settings for the workspace (workspace-specific overrides combined with global settings).

cURL

curl  https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings \
  -H "Content-Type: application/json" \
  -u <email>:<password>

Go

req, err := http.NewRequest(http.MethodGet, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings")
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
req.SetBasicAuth("<email>", "<password>")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    print(err)
}

defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    print(err)
}

fmt.Print(string(body))

Ruby

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings')
req = Net::HTTP::Get.new(uri)
req['Content-Type'] = "application/json"
req.basic_auth '<email>', '<password>'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts JSON.parse(res.body)

JavaScript

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings", {
  method: "GET",
  headers: {
	"Content-Type": "application/json",
	"Authorization": `Basic ${base64.encode(<email>:<password>)}`
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

Python

import requests
from base64 import b64encode

data = requests.get('https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings', headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

Rust

extern crate tokio;
extern crate serde_json;
use reqwest::{Client};
use reqwest::header::{CONTENT_TYPE};

#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
  let client = Client::new().basic_auth("<email>", "<password>");
  let json = client.request(Method::GET, "https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings".to_string())
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Parameters

Path

name	type	required	description
workspace_id	integer	true	workspace ID

Response

200

Settings retrieved successfully

Name	Type	Description
active_timesheet_setup_period_days	integer	null
active_timesheet_setup_periodicity	string	ActiveTimesheetSetupPeriodicity is the periodicity of the setup the caller is enrolled in, or null when they are not a member of one. Valid values: weekly, monthly, days.
active_timesheet_setup_start_date	string	null
approvals_configured	boolean	-
autolog_time	boolean	-
has_opened_focus	boolean	-
is_timesheet_approver	boolean	IsTimesheetApprover reports whether the caller is assigned as an approver on at least one active setup in this workspace.
onboarding_intent	string	Valid values: track, plan, projects.
onboarding_invited_user_ids	Array of integer	-
onboarding_project_id	integer	-
onboarding_step	string	Valid values: team-size, invite, calendar, first-entry, welcome, track, project-sidebar, project-list, project-details, project-estimate, plan-calendar, plan-task, plan-details, timeline, capacity, done.
onboarding_task_id	integer	-
onboarding_team_size	string	Valid values: just-me, 2-5, 6-20, 21-50, 50+, skipped.
work_introduction_dismissed	boolean	-

500

Internal server error

PATCH Partial update user workspace settings

https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings

Updates workspace-specific user settings. Setting a value to null removes the workspace override and reverts to the global setting.

cURL

curl -X PATCH https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings \
  -H "Content-Type: application/json" \
  -d '\{"autolog_time":"boolean","has_opened_focus":"boolean","onboarding_intent":"string","onboarding_invited_user_ids":[\{\}],"onboarding_project_id":"integer","onboarding_step":"string","onboarding_task_id":"integer","onboarding_team_size":"string","work_introduction_dismissed":"boolean"\}' \
  -u <email>:<password>

Go

bytes, err := json.Marshal('\{"autolog_time":"boolean","has_opened_focus":"boolean","onboarding_intent":"string","onboarding_invited_user_ids":[\{\}],"onboarding_project_id":"integer","onboarding_step":"string","onboarding_task_id":"integer","onboarding_team_size":"string","work_introduction_dismissed":"boolean"\}')
if err != nil {
    print(err)
}
req, err := http.NewRequest(http.MethodGet, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings", bytes.NewBuffer(bytes))
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
req.SetBasicAuth("<email>", "<password>")

client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
    print(err)
}

defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
    print(err)
}

fmt.Print(string(body))

Ruby

require 'net/http'
require 'uri'
require 'json'

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = "application/json"
req.body = \{"autolog_time":"boolean","has_opened_focus":"boolean","onboarding_intent":"string","onboarding_invited_user_ids":[\{\}],"onboarding_project_id":"integer","onboarding_step":"string","onboarding_task_id":"integer","onboarding_team_size":"string","work_introduction_dismissed":"boolean"\}.to_json
req.basic_auth '<email>', '<password>'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts JSON.parse(res.body)

JavaScript

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings", {
  method: "PATCH",
  body: \{"autolog_time":"boolean","has_opened_focus":"boolean","onboarding_intent":"string","onboarding_invited_user_ids":[\{\}],"onboarding_project_id":"integer","onboarding_step":"string","onboarding_task_id":"integer","onboarding_team_size":"string","work_introduction_dismissed":"boolean"\},
  headers: {
	"Content-Type": "application/json",
	"Authorization": `Basic ${base64.encode(<email>:<password>)}`
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

Python

import requests
from base64 import b64encode

data = requests.patch('https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings', json=\{"autolog_time":"boolean","has_opened_focus":"boolean","onboarding_intent":"string","onboarding_invited_user_ids":[\{\}],"onboarding_project_id":"integer","onboarding_step":"string","onboarding_task_id":"integer","onboarding_team_size":"string","work_introduction_dismissed":"boolean"\}, headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

Rust

extern crate tokio;
extern crate serde_json;
use reqwest::{Client};
use reqwest::header::{CONTENT_TYPE};

#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
  let client = Client::new().basic_auth("<email>", "<password>");
  let json = client.request(Method::PATCH, "https://focus.toggl.com/api/workspaces/{workspace_id}/users/me/settings".to_string())
.json(&serde_json::json!(\{"autolog_time":"boolean","has_opened_focus":"boolean","onboarding_intent":"string","onboarding_invited_user_ids":[\{\}],"onboarding_project_id":"integer","onboarding_step":"string","onboarding_task_id":"integer","onboarding_team_size":"string","work_introduction_dismissed":"boolean"\}))
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Parameters

Path

name	type	required	description
workspace_id	integer	true	workspace ID

Body

Name	Type	Description
autolog_time	boolean	null
has_opened_focus	boolean	-
onboarding_intent	string	Valid values: track, plan, projects.
onboarding_invited_user_ids	Array of integer	-
onboarding_project_id	integer	-
onboarding_step	string	Valid values: team-size, invite, calendar, first-entry, welcome, track, project-sidebar, project-list, project-details, project-estimate, plan-calendar, plan-task, plan-details, timeline, capacity, done.
onboarding_task_id	integer	-
onboarding_team_size	string	Valid values: just-me, 2-5, 6-20, 21-50, 50+, skipped.
work_introduction_dismissed	boolean	Set true after skipping or accepting the introduction; false does not reset it.

Response

200

Successfully updated

Name	Type	Description
autolog_time	boolean	-
has_opened_focus	boolean	-
onboarding_intent	string	Valid values: track, plan, projects.
onboarding_invited_user_ids	Array of integer	-
onboarding_project_id	integer	-
onboarding_step	string	Valid values: team-size, invite, calendar, first-entry, welcome, track, project-sidebar, project-list, project-details, project-estimate, plan-calendar, plan-task, plan-details, timeline, capacity, done.
onboarding_task_id	integer	-
onboarding_team_size	string	Valid values: just-me, 2-5, 6-20, 21-50, 50+, skipped.
work_introduction_dismissed	boolean	-

400

Invalid request

500

Internal server error