Tracking

GET Get current tracked time entry

https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/current

Get current tracked time entry.

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

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

fetch("https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/current", {
  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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/current', 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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/current".to_string())
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Parameters

Path

name	type	required	description
organization_id	integer	true	organization ID
workspace_id	integer	true	workspace ID

Response

200

Time entry

Name	Type	Description
archived_at	string	-
billable	boolean	-
billable_source	string	Whether `billable` was set on the entry (`manual`) or resolved from its task, else its project (`task_default`). Valid values: `manual`, `task_default`.
calendar_event_id	integer	-
calendar_id	integer	CalendarID is the calendar service's calendar PK. It stays set after a calendar deselect clears calendar_event_id.
created_at	string	-
deleted_at	string	-
description	string	-
duration	integer	Tracked duration in seconds; omitted while the timer is running and for an entry that is only planned.
id	integer	-
pattern_generated	boolean	PatternGenerated is the response-facing derivative of GeneratedByTaskID: true when the entry was materialized by a series pattern.
pattern_managed	boolean	PatternManaged reports that the pattern engine owns this entry. Server-owned; present in responses, never bindable from a payload.
planned_at	string	-
planned_duration	integer	Planned duration in seconds.
planned_start	string	Planned start, for time planned on the calendar.
project_id	integer	-
start	string	Start of the tracked time; omitted for an entry that is only planned.
tag_ids	Array of integer	TagIDs is the entry's manual tag override. NULL (nil) means no override: the effective tags fall through to the linked task's tags. A non-nil value — including an empty array — is entry-authoritative.
tags	Array of object	Tags is the hydrated effective tag set: the override when TagIDs is set, else the linked task's active tags. Read-only.
task_id	integer	null
time_block_id	integer	-
timezone	string	Timezone is the entry creator's IANA timezone snapshotted at creation; NULL when unresolved.
toggl_user_id	integer	-
tracked_at	string	-
type	string	The type of time entry: either an activity or a break. Valid values: `activity`, `break`.
updated_at	string	-
workspace_id	integer	-

Name	Type	Description
color	string	-
id	integer	-
name	string	-

204

Not tracking a time entry

400

Invalid request

403

Insufficient permissions

500

Internal Server Error

POST Start tracking time entry

https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start

Start tracking time entry. If a running entry already exists it is automatically stopped and the new entry is returned.

curl -X POST https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start \
  -H "Content-Type: application/json" \
  -d '\{"billable":"boolean","calendar_event_id":"integer","description":"string","project_id":"integer","start":"string","tag_ids":[\{\}],"task_id":"integer","type":"string"\}' \
  -u <email>:<password>

bytes, err := json.Marshal('\{"billable":"boolean","calendar_event_id":"integer","description":"string","project_id":"integer","start":"string","tag_ids":[\{\}],"task_id":"integer","type":"string"\}')
if err != nil {
    print(err)
}
req, err := http.NewRequest(http.MethodPost, 
  "https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start", 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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = "application/json"
req.body = \{"billable":"boolean","calendar_event_id":"integer","description":"string","project_id":"integer","start":"string","tag_ids":[\{\}],"task_id":"integer","type":"string"\}.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)

fetch("https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start", {
  method: "POST",
  body: \{"billable":"boolean","calendar_event_id":"integer","description":"string","project_id":"integer","start":"string","tag_ids":[\{\}],"task_id":"integer","type":"string"\},
  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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start', json=\{"billable":"boolean","calendar_event_id":"integer","description":"string","project_id":"integer","start":"string","tag_ids":[\{\}],"task_id":"integer","type":"string"\}, 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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/start".to_string())
.json(&serde_json::json!(\{"billable":"boolean","calendar_event_id":"integer","description":"string","project_id":"integer","start":"string","tag_ids":[\{\}],"task_id":"integer","type":"string"\}))
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Parameters

Path

name	type	required	description
organization_id	integer	true	organization ID
workspace_id	integer	true	workspace ID

Body

Name	Type	Description
billable	boolean	-
calendar_event_id	integer	-
description	string	-
project_id	integer	-
start	string	-
tag_ids	Array of integer	TagIDs sets a manual tag override on the started entry; absent/null inherits the task's tags.
task_id	integer	-
type	string	The type of time entry: either an activity or a break. Valid values: `activity`, `break`.

Response

200

Time entry

Name	Type	Description
archived_at	string	-
billable	boolean	-
billable_source	string	Whether `billable` was set on the entry (`manual`) or resolved from its task, else its project (`task_default`). Valid values: `manual`, `task_default`.
calendar_event_id	integer	-
calendar_id	integer	CalendarID is the calendar service's calendar PK. It stays set after a calendar deselect clears calendar_event_id.
created_at	string	-
deleted_at	string	-
description	string	-
duration	integer	Tracked duration in seconds; omitted while the timer is running and for an entry that is only planned.
id	integer	-
pattern_generated	boolean	PatternGenerated is the response-facing derivative of GeneratedByTaskID: true when the entry was materialized by a series pattern.
pattern_managed	boolean	PatternManaged reports that the pattern engine owns this entry. Server-owned; present in responses, never bindable from a payload.
planned_at	string	-
planned_duration	integer	Planned duration in seconds.
planned_start	string	Planned start, for time planned on the calendar.
project_id	integer	-
start	string	Start of the tracked time; omitted for an entry that is only planned.
tag_ids	Array of integer	TagIDs is the entry's manual tag override. NULL (nil) means no override: the effective tags fall through to the linked task's tags. A non-nil value — including an empty array — is entry-authoritative.
tags	Array of object	Tags is the hydrated effective tag set: the override when TagIDs is set, else the linked task's active tags. Read-only.
task_id	integer	null
time_block_id	integer	-
timezone	string	Timezone is the entry creator's IANA timezone snapshotted at creation; NULL when unresolved.
toggl_user_id	integer	-
tracked_at	string	-
type	string	The type of time entry: either an activity or a break. Valid values: `activity`, `break`.
updated_at	string	-
workspace_id	integer	-

Name	Type	Description
color	string	-
id	integer	-
name	string	-

400

Invalid request

403

Insufficient permissions

404

User task does not exist

422

Required field is missing (error=required_fields_missing) on the new entry, or on the running entry it would stop (error_values.time_entry_id names that entry)

500

Internal Server Error

POST Stop tracking time entry

https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop

Stop tracking time entry.

curl -X POST https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop \
  -H "Content-Type: application/json" \
  -d '\{"end":"string"\}' \
  -u <email>:<password>

bytes, err := json.Marshal('\{"end":"string"\}')
if err != nil {
    print(err)
}
req, err := http.NewRequest(http.MethodPost, 
  "https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop", 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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = "application/json"
req.body = \{"end":"string"\}.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)

fetch("https://focus.toggl.com/api/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop", {
  method: "POST",
  body: \{"end":"string"\},
  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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop', json=\{"end":"string"\}, 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/organizations/{organization_id}/workspaces/{workspace_id}/tracking/stop".to_string())
.json(&serde_json::json!(\{"end":"string"\}))
  .header(CONTENT_TYPE, "application/json")
  .send()
  .await?
  .json()
  .await?;
  
  println!("{:#?}", json);

  Ok(())
}

Parameters

Path

name	type	required	description
organization_id	integer	true	organization ID
workspace_id	integer	true	workspace ID

Body

Name	Type	Description
end	string	-

Response

200

Time entry

Name	Type	Description
archived_at	string	-
billable	boolean	-
billable_source	string	Whether `billable` was set on the entry (`manual`) or resolved from its task, else its project (`task_default`). Valid values: `manual`, `task_default`.
calendar_event_id	integer	-
calendar_id	integer	CalendarID is the calendar service's calendar PK. It stays set after a calendar deselect clears calendar_event_id.
created_at	string	-
deleted_at	string	-
description	string	-
duration	integer	Tracked duration in seconds; omitted while the timer is running and for an entry that is only planned.
id	integer	-
pattern_generated	boolean	PatternGenerated is the response-facing derivative of GeneratedByTaskID: true when the entry was materialized by a series pattern.
pattern_managed	boolean	PatternManaged reports that the pattern engine owns this entry. Server-owned; present in responses, never bindable from a payload.
planned_at	string	-
planned_duration	integer	Planned duration in seconds.
planned_start	string	Planned start, for time planned on the calendar.
project_id	integer	-
start	string	Start of the tracked time; omitted for an entry that is only planned.
tag_ids	Array of integer	TagIDs is the entry's manual tag override. NULL (nil) means no override: the effective tags fall through to the linked task's tags. A non-nil value — including an empty array — is entry-authoritative.
tags	Array of object	Tags is the hydrated effective tag set: the override when TagIDs is set, else the linked task's active tags. Read-only.
task_id	integer	null
time_block_id	integer	-
timezone	string	Timezone is the entry creator's IANA timezone snapshotted at creation; NULL when unresolved.
toggl_user_id	integer	-
tracked_at	string	-
type	string	The type of time entry: either an activity or a break. Valid values: `activity`, `break`.
updated_at	string	-
workspace_id	integer	-

Name	Type	Description
color	string	-
id	integer	-
name	string	-

400

Invalid request

403

Insufficient permissions

404

Not tracking a time entry

422

Required field is missing (error=required_fields_missing) or is being cleared on a grandfathered entry (error=required_fields_deletion)

500

Internal Server Error

GET Get current tracked time entry​

Parameters​

Path​

Response​

200​

tags​

204​

400​

403​

500​

POST Start tracking time entry​

Parameters​

Path​

Body​

Response​

200​

tags​

400​

403​

404​

422​

500​

POST Stop tracking time entry​

Parameters​

Path​

Body​

Response​

200​

tags​

400​

403​

404​

422​

500​

GET Get current tracked time entry

Parameters

Path

Response

200

tags

204

400

403

500

POST Start tracking time entry

Parameters

Path

Body

Response

200

tags

400

403

404

422

500

POST Stop tracking time entry

Parameters

Path

Body

Response

200

tags

400

403

404

422

500