Skip to main content
GET
/
{team_id}
/
time
/
entries
List or aggregate time entries
curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/time/entries \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

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

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[]
​
group_by
enum<string>
Available options:
user,
scope,
week,
billable
​
buckets
object[]