Skip to main content
GET
/
{team_id}
/
time
/
reports
/
week
Time report grouped by ISO week
curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/time/reports/week \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superthread.com/v1/{team_id}/time/reports/week', 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/reports/week",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.superthread.com/v1/{team_id}/time/reports/week")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "filters": {
    "from": 1735689600,
    "to": 1738368000,
    "billable": true,
    "user_ids": [
      "<string>"
    ],
    "project_ids": [
      "<string>"
    ],
    "category_ids": [
      "<string>"
    ]
  },
  "buckets": [
    {
      "week_start": 1608742037016,
      "total_seconds": 144000,
      "total_cents": 500000,
      "entry_count": 120
    }
  ]
}
{
  "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.

Path Parameters

​
team_id
string
required

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

Query Parameters

​
from
integer<int64>
required

Lower bound (inclusive) for the report window, as a Unix timestamp in seconds.

​
to
integer<int64>
required

Upper bound (exclusive) for the report window, as a Unix timestamp in seconds.

​
billable
boolean

Optional filter — restrict to billable (true) or non-billable (false) entries.

​
user_ids
string[]

Optional filter — restrict to entries from these user IDs.

​
project_ids
string[]

Optional filter — restrict to entries logged on cards within these project IDs.

​
category_ids
string[]

Optional filter — restrict to entries logged against these time category IDs.

​
format
enum<string>

Response format. json (default) returns the JSON envelope. csv returns a flat CSV export with one row per bucket (text/csv content-type).

Available options:
json,
csv

Response

Aggregated time totals by ISO week

​
filters
object

Echo of the filters that were applied to produce this report.

​
buckets
object[]