Time summary
Time summary. Totals and grouped subtotals of tracked time. groupBy day|week|month|client|project|task|member (weeks start Monday); groups are paged. Omit from and to for the previous calendar month in the caller's timezone; from alone runs through today; to without from is a 422. Billable = billable time on HOURLY projects. Owner/Admin/Manager responses include estimatedBillable per client currency (each entry rounded up to 15 minutes at the project's current rate). Members see only their own time, only on projects they currently belong to, and never money, and a userId other than their own is a 404. Any role. Plan: Studio or Agency (reports); otherwise 402. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Query Parameters
Inclusive start (entry date), YYYY-MM-DD.
Inclusive end (entry date), YYYY-MM-DD. Must not be before from (422).
Filter by client. Repeat the parameter for several (max 25). Unknown ids return 404.
Filter by project. Repeat the parameter for several (max 25). Unknown ids return 404.
Filter by team member (user id). Repeat the parameter for several (max 25). Unknown ids return 404.
1-based page (default 1). A page past the end returns an empty page.
Rows per page (default 50).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/reports/time"{ "data": { "range": { "from": "2019-08-24", "to": "2019-08-24" }, "rangeDefaulted": "previous_month", "today": "2019-08-24", "timezone": "string", "scope": "self", "groupBy": "none", "filters": { "clientIds": [ "c055e856-96a7-4f69-80a6-b75690833d98" ], "projectIds": [ "b2d9859a-b2e9-4f49-b393-9a25d0eff2f8" ], "userIds": [ "416ebe2c-ad2f-4853-b1f3-0c3479151dfe" ], "billable": true }, "totals": { "entryCount": 0, "totalSeconds": 0, "billableSeconds": 0, "nonBillableSeconds": 0, "billablePercent": 0, "estimatedBillable": [ { "currency": "str", "amount": "string", "billableSeconds": 0 } ] }, "groups": [ { "key": "string", "id": "string", "name": "string", "date": "2019-08-24", "weekStart": "2019-08-24", "month": "string", "entryCount": 0, "totalSeconds": 0, "billableSeconds": 0, "nonBillableSeconds": 0, "billablePercent": 0, "estimatedBillable": [ { "currency": "str", "amount": "string", "billableSeconds": 0 } ] } ], "pagination": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0, "hasMore": true } }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}{ "error": { "code": "unauthenticated", "message": "string", "fields": { "property1": "string", "property2": "string" }, "requiredPlan": "studio", "feature": "string", "requestId": "string" }}Set the running timer's note
Any role; caller's own timer only. Overwrites the whole note. Plan: Studio or Agency (API access). Scope: write.
Uninvoiced work (ready to invoice)
Billable work not yet invoiced, per client and project: hourly time (stopped entries only: running timers and zero-length entries are left out; value at the current rate, each entry rounded up to 15 minutes), billable expenses and remaining fixed-fee balances, with per-currency totals. from/to filter time-entry and expense dates; fixed-fee balances are CURRENT balances and are not date-filtered. Amounts are advisory estimates. Paged by client. Owner, Admin or Manager only: a Member token gets 403. Plan: Studio or Agency (reports); otherwise 402. Read-only; requires a token with read scope. Unknown or repeated (non-list) query parameters, impossible dates and inverted ranges return 422 with `fields`. Money is an exact decimal string paired with its currency; amounts in different currencies are never added together and nothing is converted. Responses are private (Cache-Control: private, no-store; Vary: Authorization).