Start a timer

POST

{team_id}

time

timer

Start a timer

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/time/timer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "card_id": "2700",
  "scope_type": "card",
  "scope_id": "<string>",
  "time_category_id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
  "category_id": "<string>",
  "description": "<string>",
  "billable": true
}
'

import requests

url = "https://api.superthread.com/v1/{team_id}/time/timer"

payload = {
    "card_id": "2700",
    "scope_type": "card",
    "scope_id": "<string>",
    "time_category_id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
    "category_id": "<string>",
    "description": "<string>",
    "billable": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    card_id: '2700',
    scope_type: 'card',
    scope_id: '<string>',
    time_category_id: 'tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB',
    category_id: '<string>',
    description: '<string>',
    billable: true
  })
};

fetch('https://api.superthread.com/v1/{team_id}/time/timer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superthread.com/v1/{team_id}/time/timer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'card_id' => '2700',
    'scope_type' => 'card',
    'scope_id' => '<string>',
    'time_category_id' => 'tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB',
    'category_id' => '<string>',
    'description' => '<string>',
    'billable' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superthread.com/v1/{team_id}/time/timer"

	payload := strings.NewReader("{\n  \"card_id\": \"2700\",\n  \"scope_type\": \"card\",\n  \"scope_id\": \"<string>\",\n  \"time_category_id\": \"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"billable\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.superthread.com/v1/{team_id}/time/timer")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card_id\": \"2700\",\n  \"scope_type\": \"card\",\n  \"scope_id\": \"<string>\",\n  \"time_category_id\": \"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"billable\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superthread.com/v1/{team_id}/time/timer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card_id\": \"2700\",\n  \"scope_type\": \"card\",\n  \"scope_id\": \"<string>\",\n  \"time_category_id\": \"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"billable\": true\n}"

response = http.request(request)
puts response.read_body

{
  "active_timer": {
    "team_id": "tDsu0j19",
    "user_id": "uR2dws11",
    "card_id": "2700",
    "scope_type": "card",
    "scope_id": "<string>",
    "time_category_id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
    "category_id": "<string>",
    "started_at": 1608742037016,
    "description": "Pairing with Alex on the API spec",
    "billable": true,
    "version": 1
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

Client-generated ULID used to replay a time mutation safely. Optional only for legacy clients during rolling migration.

Path Parameters

team_id

string

required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Body

application/json

card_id

string

Card receiving the timer. Preferred over the legacy scope fields.

Example:

"2700"

scope_type

enum<string>

Legacy time-entry target type retained for rolling-client compatibility.

Available options:

card,

category

Example:

"card"

scope_id

string | null

Legacy card ID, used when card_id is omitted.

time_category_id

string | null

Example:

"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB"

category_id

string | null

Legacy alias for time_category_id.

description

string | null

billable

boolean | null

Response

Timer started

active_timer

object

A user's currently-running timer. Singleton per user per workspace.

Show child attributes

⌘I

Start a timer

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/time/timer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "card_id": "2700",
  "scope_type": "card",
  "scope_id": "<string>",
  "time_category_id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
  "category_id": "<string>",
  "description": "<string>",
  "billable": true
}
'

import requests

url = "https://api.superthread.com/v1/{team_id}/time/timer"

payload = {
    "card_id": "2700",
    "scope_type": "card",
    "scope_id": "<string>",
    "time_category_id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
    "category_id": "<string>",
    "description": "<string>",
    "billable": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    card_id: '2700',
    scope_type: 'card',
    scope_id: '<string>',
    time_category_id: 'tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB',
    category_id: '<string>',
    description: '<string>',
    billable: true
  })
};

fetch('https://api.superthread.com/v1/{team_id}/time/timer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superthread.com/v1/{team_id}/time/timer",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'card_id' => '2700',
    'scope_type' => 'card',
    'scope_id' => '<string>',
    'time_category_id' => 'tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB',
    'category_id' => '<string>',
    'description' => '<string>',
    'billable' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superthread.com/v1/{team_id}/time/timer"

	payload := strings.NewReader("{\n  \"card_id\": \"2700\",\n  \"scope_type\": \"card\",\n  \"scope_id\": \"<string>\",\n  \"time_category_id\": \"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"billable\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.superthread.com/v1/{team_id}/time/timer")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card_id\": \"2700\",\n  \"scope_type\": \"card\",\n  \"scope_id\": \"<string>\",\n  \"time_category_id\": \"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"billable\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superthread.com/v1/{team_id}/time/timer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card_id\": \"2700\",\n  \"scope_type\": \"card\",\n  \"scope_id\": \"<string>\",\n  \"time_category_id\": \"tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB\",\n  \"category_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"billable\": true\n}"

response = http.request(request)
puts response.read_body

{
  "active_timer": {
    "team_id": "tDsu0j19",
    "user_id": "uR2dws11",
    "card_id": "2700",
    "scope_type": "card",
    "scope_id": "<string>",
    "time_category_id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
    "category_id": "<string>",
    "started_at": 1608742037016,
    "description": "Pairing with Alex on the API spec",
    "billable": true,
    "version": 1
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Saved filters

Time tracking

Search

Authorizations

Headers

Path Parameters

Body

Response