Skip to main content
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 '
{
  "scope_type": "card",
  "scope_id": "2700",
  "description": "<string>",
  "billable": true
}
'
{
  "active_timer": {
    "team_id": "tDsu0j19",
    "user_id": "uR2dws11",
    "scope_type": "card",
    "scope_id": "2700",
    "started_at": 1608742037016,
    "description": "Pairing with Alex on the API spec",
    "billable": true,
    "version": 1
  }
}

Authorizations

​
Authorization
string
header
required

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

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
​
scope_type
enum<string>
required

Scope a time entry attaches to. card ties the entry to a specific card (and rolls up to its epic), while category ties the entry to a workspace-level time category not associated with any card.

Available options:
card,
category
Example:

"card"

​
scope_id
string
required
Example:

"2700"

​
description
string | null
​
billable
boolean | null

Response

Timer started

​
active_timer
object

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