Start the caller's timer
Start the caller's timer. Any role; acts only on the caller's own timer. A Member needs access to the project. Plan: Studio or Agency (API access). Scope: write. Stops (finalizes) the running timer named by expectedRunningTimerId, if any, in the same transaction; that stop updates its project's budget totals and may add in-app budget alerts. The project, its client and the task must be open: an archived one is a 422 that names what to restore.
Authorization
BearerAuth Personal Access Token. Mint at Settings → API. Token shape: hsk_<env>_<prefix12>_<secret32>.
In: header
Header Parameters
Caller-generated UUID/ULID; replay returns the cached response within 24h.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Starts the caller's own timer now. There is no occurredAt: timers cannot be backdated through the API.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/time-entries/timer/start" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "expectedRunningTimerId": "8d96ce2a-63fe-4e16-ada0-98f074bdb545" }'{ "data": { "timer": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8", "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec", "durationSeconds": 0, "billable": true, "note": "string", "entryDate": "2019-08-24", "startedAt": "2019-08-24T14:15:22Z", "stoppedAt": "2019-08-24T14:15:22Z", "isRunning": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z" }, "stoppedTimer": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8", "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec", "durationSeconds": 0, "billable": true, "note": "string", "entryDate": "2019-08-24", "startedAt": "2019-08-24T14:15:22Z", "stoppedAt": "2019-08-24T14:15:22Z", "isRunning": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z" } }, "warnings": [ "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" }}{ "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" }}List saved payout methods
Read-only. Active saved method labels (id, name, type) for savedMethodId. No account numbers or bank details. Query parameters are rejected (422). Owner/Admin only (Managers and Members receive 403 before any record lookup); Agency plan (`teamPayouts`, 402 with requiredPlan agency otherwise). Requires the `read` scope. Money values are exact decimal strings; dates are ISO calendar dates.
Stop the caller's running timer
Any role; caller's own timer only. Plan: Studio or Agency (API access). Scope: write.