Workspace-settings

GET Get current user's permissions in workspace

https://focus.toggl.com/api/workspaces/{workspace_id}/permissions

Returns the complete list of permissions for the current user in the specified workspace. This combines unconditional permissions from the user's role with conditional permissions based on workspace settings.

cURL

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

Go

req, err := http.NewRequest(http.MethodGet, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/permissions")
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}/permissions')
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}/permissions", {
  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}/permissions', 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}/permissions".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

Permissions retrieved successfully

Name	Type	Description
permissions	Array of string	-

403

User does not have access to workspace

500

Internal server error

GET Get workspace settings

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

Returns default_private to all workspace members; permission settings are included only for workspace admins.

cURL

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

Go

req, err := http.NewRequest(http.MethodGet, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/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}/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}/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}/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}/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
created_at	string	-
default_private	boolean	-
settings	object	-
updated_at	string	-
workspace_id	integer	-

settings

403

User does not have access to workspace

500

Internal server error

PUT Update workspace settings

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

Updates permission settings and/or default_private atomically. Omitted fields are preserved; at least one is required and null is invalid. Requires workspace-admin rights. Private defaults require access_private_projects_tasks_feature. The settings object should map role IDs to their permissions. Note: Use role IDs as string keys (e.g., "15" for ws_admin, "16" for ws_manager, "17" for ws_user), not role codes. Available permissions:

• Clients: create_client, rename_client, archive_client, delete_client
• Statuses: create_status, update_status, delete_status
• Tags: create_tags, update_tags, delete_tags

\{
"settings": \{
"15": \{
"create_client": true,
"rename_client": true,
"archive_client": true,
"delete_client": true,
"create_status": true,
"update_status": true,
"delete_status": true,
"create_tags": true,
"update_tags": true,
"delete_tags": true
\},
"16": \{
"create_client": true,
"rename_client": true,
"archive_client": false,
"delete_client": false,
"create_status": true,
"update_status": true,
"delete_status": false,
"create_tags": true,
"update_tags": true,
"delete_tags": false
\},
"17": \{
"create_client": false,
"rename_client": false,
"archive_client": false,
"delete_client": false,
"create_status": false,
"update_status": false,
"delete_status": false,
"create_tags": false,
"update_tags": false,
"delete_tags": false
\}
\}
\}

cURL

curl -X PUT https://focus.toggl.com/api/workspaces/{workspace_id}/settings \
  -H "Content-Type: application/json" \
  -d '\{"default_private":"boolean","settings":\{\}\}' \
  -u <email>:<password>

Go

bytes, err := json.Marshal('\{"default_private":"boolean","settings":\{\}\}')
if err != nil {
    print(err)
}
req, err := http.NewRequest(http.MethodPut, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/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}/settings')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = "application/json"
req.body = \{"default_private":"boolean","settings":\{\}\}.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}/settings", {
  method: "PUT",
  body: \{"default_private":"boolean","settings":\{\}\},
  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.put('https://focus.toggl.com/api/workspaces/{workspace_id}/settings', json=\{"default_private":"boolean","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::PUT, "https://focus.toggl.com/api/workspaces/{workspace_id}/settings".to_string())
.json(&serde_json::json!(\{"default_private":"boolean","settings":\{\}\}))
  .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
default_private	boolean	-
settings	object	-

settings

Response

200

Settings updated successfully

Name	Type	Description
created_at	string	-
default_private	boolean	-
settings	object	-
updated_at	string	-
workspace_id	integer	-

settings

400

Invalid request body

402

Private projects and tasks are not available on the current plan

403

User is not authorized to update workspace settings

500

Internal server error