Skip to content

All resources

time

11 endpoints

post /projects/{id}/time-entries/apply-rates

Re-rate a project's unrated time entries

Requires authentication

Admin only. Re-resolves the snapshots of unlocked entries whose rate never resolved, leaving already-rated and locked entries untouched. Never runs automatically.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope

get /projects/{id}/time-export

Export a project's time entries as CSV

Requires authentication

Admin only. One row per entry; money stays in integer minor units so the file reconciles exactly with the API.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id
fromquerystringnoLower bound on startedAt (RFC3339 or YYYY-MM-DD)
toquerystringnoUpper bound on startedAt (RFC3339 or YYYY-MM-DD, inclusive)

Responses

  • 200 CSV document · string
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope

get /projects/{id}/time-summary

Time report for one project

Requires authentication

Totals plus per-user and per-task breakdowns. Money and billing items are included only for an admin on a cost-tracking project.

Parameters

NameInTypeRequiredDescription
idpathintegeryesProject id
fromquerystringnoLower bound on startedAt (RFC3339 or YYYY-MM-DD)
toquerystringnoUpper bound on startedAt (RFC3339 or YYYY-MM-DD, inclusive)
groupByquerystring (user | task)noWhich breakdown to compute; both when omitted

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope

get /tasks/{id}/time-summary

Time rollup for one task

Requires authentication

Own minutes, subtree total, and contributors. Money is included only for an admin on a cost-tracking project.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTask id

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope

get /time-entries

List time entries

Requires authentication

Members see only their own entries; an admin may filter by userId. Financial fields are absent for members.

Parameters

NameInTypeRequiredDescription
projectIdqueryintegernoProject id
userIdqueryintegernoUser id (admin only)
taskIdqueryintegernoTask id
fromquerystringnoLower bound on startedAt (RFC3339 or YYYY-MM-DD)
toquerystringnoUpper bound on startedAt (RFC3339 or YYYY-MM-DD, inclusive)

Responses

  • 200 OK · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope

post /time-entries

Log a time entry

Requires authentication

Creates a manual or week-grid entry. The billable and cost rates are resolved once here and frozen onto the row; later edits never re-resolve them.

Request body: dto.CreateTimeEntryRequest

NameTypeRequiredDescription
billablebooleannoBillable omitted defaults to true, matching the column default.
durationMinutesintegerno
entrySourcedomain.TimeEntrySourceno
notesstringno
startedAtobjectnoStartedAt accepts both RFC3339 and bare "YYYY-MM-DD" (see FlexDate) — the week grid logs against a day, not a clock time.
taskIdintegerno
userIdintegernoUserID logs the entry against someone else. Admin only; omit for self.

Responses

  • 201 Created · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope

patch /time-entries/{id}

Edit a time entry

Requires authentication

Partial edit. Rates are never re-resolved. A locked entry returns 409.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTime entry id

Request body: dto.UpdateTimeEntryRequest

NameTypeRequiredDescription
billablebooleanno
durationMinutesintegerno
notesstringno
startedAtdto.FlexDateno

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

delete /time-entries/{id}

Delete a time entry

Requires authentication

Soft-deletes the entry. A locked entry returns 409.

Parameters

NameInTypeRequiredDescription
idpathintegeryesTime entry id

Responses

  • 204 No Content
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 403 Forbidden · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

get /time-entries/running

Get the caller's running timer

Requires authentication

Returns the caller's open entry, or no data when nothing is running.

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope

post /time-entries/start

Start a timer

Requires authentication

Opens a running entry on a task. Returns 409 when one already runs — silently stopping the previous timer would lose time the user cannot recover.

Request body: dto.StartTimerRequest

NameTypeRequiredDescription
taskIdintegerno

Responses

  • 201 Created · object
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

post /time-entries/stop

Stop the caller's running timer

Requires authentication

Closes the open entry and writes the elapsed span, rounded half-up to the nearest minute.

Responses

  • 200 OK · object
  • 401 Unauthorized · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope