Statuses

GET List statuses

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

Returns a list of statuses based on the workspace ID.

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

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

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

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

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/statuses", {
  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));

import requests
from base64 import b64encode

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

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}/statuses".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

Query

name	type	required	description
name	string	false	filter by status name
type	string	false	filter by status type
page	integer	false	page number
per_page	integer	false	results per page
order_by	[]string	false	order by

Response

200

Name	Type	Description
data	Array of object	-
page	integer	-
per_page	integer	-

data

Name	Type	Description
created_at	string	-
deleted_at	string	-
emoji	string	-
id	integer	-
name	string	-
position	integer	-
type	string	-
updated_at	string	-
workspace_id	integer	-

400

Invalid request

500

Internal Server Error

POST Create a new status

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

Creates a new status with the provided details.

curl -X POST https://focus.toggl.com/api/workspaces/{workspace_id}/statuses \
  -H "Content-Type: application/json" \
  -d '\{"emoji":"string","name":"string","position":"integer"\}' \
  -u <email>:<password>

bytes, err := json.Marshal('\{"emoji":"string","name":"string","position":"integer"\}')
if err != nil {
    print(err)
}
req, err := http.NewRequest(http.MethodPost, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/statuses", 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))

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

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Post.new(uri.path)
req['Content-Type'] = "application/json"
req.body = \{"emoji":"string","name":"string","position":"integer"\}.to_json
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/statuses", {
  method: "POST",
  body: \{"emoji":"string","name":"string","position":"integer"\},
  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));

import requests
from base64 import b64encode

data = requests.post('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses', json=\{"emoji":"string","name":"string","position":"integer"\}, headers={'content-type': 'application/json', 'Authorization' : 'Basic %s' %  b64encode(b"<email>:<password>").decode("ascii")})
print(data.json())

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::POST, "https://focus.toggl.com/api/workspaces/{workspace_id}/statuses".to_string())
.json(&serde_json::json!(\{"emoji":"string","name":"string","position":"integer"\}))
  .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
emoji	string	-
name	string	-
position	integer	-

Response

201

Status created successfully

400

Invalid request

500

Internal Server Error

GET Get status by ID

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

Returns a status with the provided ID.

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

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

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

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Get.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}", {
  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));

import requests
from base64 import b64encode

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

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}/statuses/{status_id}".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
status_id	integer	true	status ID

Response

200

Name	Type	Description
created_at	string	-
deleted_at	string	-
emoji	string	-
id	integer	-
name	string	-
position	integer	-
type	string	-
updated_at	string	-
workspace_id	integer	-

400

Invalid request

500

Internal Server Error

PUT Update status

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

Update an existing statuses

curl -X PUT https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id} \
  -H "Content-Type: application/json" \
  -d '\{"emoji":"string","name":"string","position":"integer"\}'

bytes, err := json.Marshal('\{"emoji":"string","name":"string","position":"integer"\}')
if err != nil {
    print(err)
}
req, err := http.NewRequest(http.MethodPut, 
  "https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}", bytes.NewBuffer(bytes))
if err != nil {
    print(err)
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")

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))

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

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Put.new(uri.path)
req['Content-Type'] = "application/json"
req.body = \{"emoji":"string","name":"string","position":"integer"\}.to_json
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}", {
  method: "PUT",
  body: \{"emoji":"string","name":"string","position":"integer"\},
  headers: {
	"Content-Type": "application/json"
  },
})
.then((resp) => resp.json())
.then((json) => {
  console.log(json);
})
.catch(err => console.error(err));

import requests
from base64 import b64encode

data = requests.put('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}', json=\{"emoji":"string","name":"string","position":"integer"\}, headers={'content-type': 'application/json'})
print(data.json())

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();
  let json = client.request(Method::PUT, "https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}".to_string())
.json(&serde_json::json!(\{"emoji":"string","name":"string","position":"integer"\}))
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Parameters

Path

name	type	required	description
workspace_id	integer	true	workspace ID
status_id	integer	true	Status ID

Body

Name	Type	Description
emoji	string	-
name	string	-
position	integer	-

Response

200

Successfully updated status

Name	Type	Description
created_at	string	-
deleted_at	string	-
emoji	string	-
id	integer	-
name	string	-
position	integer	-
type	string	-
updated_at	string	-
workspace_id	integer	-

400

Invalid request

403

Cannot update default status

500

Internal Server Error

DELETE Delete a status by ID

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

Deletes a status with the provided ID.

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

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

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

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Delete.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}", {
  method: "DELETE",
  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));

import requests
from base64 import b64encode

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

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::DELETE, "https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}".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
status_id	integer	true	statuses ID

Response

204

Successfully deleted status

400

Invalid request

403

Cannot delete default status

500

Internal Server Error

PATCH Restore a statuses by ID

https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}/restore

Restores a statuses by the provided ID.

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

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

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

uri = URI('https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}/restore')
http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Patch.new(uri.path)
req['Content-Type'] = "application/json"
request.basic_auth '<email>', '<password>'
res = http.request(req)
puts JSON.parse(res.body)

fetch("https://focus.toggl.com/api/workspaces/{workspace_id}/statuses/{status_id}/restore", {
  method: "PATCH",
  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));

import requests
from base64 import b64encode

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

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}/statuses/{status_id}/restore".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
status_id	integer	true	statuses ID

Response

204

Successfully restored status

400

Invalid request

500

Internal Server Error

GET List statuses​

Parameters​

Path​

Query​

Response​

200​

data​

400​

500​

POST Create a new status​

Parameters​

Path​

Body​

Response​

201​

400​

500​

GET Get status by ID​

Parameters​

Path​

Response​

200​

400​

500​

PUT Update status​

Parameters​

Path​

Body​

Response​

200​

400​

403​

500​

DELETE Delete a status by ID​

Parameters​

Path​

Response​

204​

400​

403​

500​

PATCH Restore a statuses by ID​

Parameters​

Path​

Response​

204​

400​

500​

GET List statuses

Parameters

Path

Query

Response

200

data

400

500

POST Create a new status

Parameters

Path

Body

Response

201

400

500

GET Get status by ID

Parameters

Path

Response

200

400

500

PUT Update status

Parameters

Path

Body

Response

200

400

403

500

DELETE Delete a status by ID

Parameters

Path

Response

204

400

403

500

PATCH Restore a statuses by ID

Parameters

Path

Response

204

400

500