List or aggregate time entries

Returns a paginated list of time entries within a workspace, optionally filtered by scope, user, time range, or billable flag.

When aggregate=true and group_by is supplied, returns aggregated totals grouped by the specified dimension instead of the entry list. The same filters apply.

GET /{team_id}/time/entries

List or aggregate time entries

cURL

curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/time/entries \
  --header 'Authorization: Bearer <token>'

import requests

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

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/entries', 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/entries",
  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/entries"

	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/entries")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "cursor": "dmsjqh9d8w1hdjosjaasda",
  "count": 14,
  "time_entries": [
    {
      "id": "01HQK6Z9YJZ4M9JX8FVB6QXYAB",
      "type": "time_entry",
      "team_id": "tDsu0j19",
      "scope_type": "card",
      "scope_id": "2700",
      "user_id": "uR2dws11",
      "started_at": 1608742037016,
      "duration_seconds": 1800,
      "description": "Pairing with Alex on the API spec",
      "billable": true,
      "rate_snapshot_cents": 12500,
      "deleted_at": 1608742037016,
      "locked_at": 1608742037016,
      "time_created": 1608742037016,
      "time_updated": 1608742037016
    }
  ],
  "buckets": [
    {
      "user_id": "uR2dws11",
      "scope_type": "card",
      "scope_id": "2700",
      "week_start": 1608742037016,
      "billable": true,
      "total_seconds": 14400,
      "total_cents": 50000,
      "entry_count": 12
    }
  ]
}

{
  "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

scope_type · enum<string>

Filter to entries with this scope type.

Available options: card, category

scope_id · string

Filter to entries with this scope id (typically used together with scope_type).

user_id · string

Filter to entries logged by this user.

from · integer<int64>

Lower bound (inclusive) for started_at, as a unix timestamp in seconds.

to · integer<int64>

Upper bound (exclusive) for started_at, as a unix timestamp in seconds.

billable · boolean

Filter to billable (true) or non-billable (false) entries.

cursor · string

Pagination cursor returned by a previous call.

limit · integer

Page size; defaults to a server-defined value.

aggregate · boolean

When true, return aggregated buckets (buckets, group_by) instead of the entry list. Requires group_by.

group_by · enum<string>

Dimension to group aggregate buckets by. Required when aggregate=true.

Available options: user, scope, week, billable

Response

200

application/json

Paginated list of time entries, or aggregated buckets when aggregate=true.

Composite response for GET /{team_id}/time/entries. When aggregate is not set, the response carries time_entries (plus paging fields from ResponseMetadata); when aggregate=true, the response carries buckets and group_by. All fields are optional because OpenAPI 2.0 cannot express a oneOf cleanly.

cursor · string · required

Example:

"dmsjqh9d8w1hdjosjaasda"

count · integer · required

Example:

14

time_entries · object[]

Show child attributes

group_by · enum<string>

Available options: user, scope, week, billable

buckets · object[]

Show child attributes