Submit a week
/v1/projects/{project}/timesheets/submit in the Timesheets API.
curl -X POST https://api.example.test/v1/projects/$PROJECT_ID/timesheets/submit \ -H "Authorization: Bearer $TOKEN" \ -H "Idempotency-Key: 5c1e3f8a-9b2d-4e7f-8a6c-2d4b6e8f0a12" \ -H "Content-Type: application/json" \ -d '{"week_start":"2026-11-04","summary":"Two days on the tier job, one on the receipt bug."}'Puts the holder's week to the project's approvers, opening the week's row when it has none and tallying its logs as they stand; user_id puts another member's week forward when the holder may approve time on the project. When the approvers asked for changes, the same call opens the next round. Answers with the approval request; the week's logs hold from then on, approval.requested and timesheet.status_changed go out, and the approvers are told.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The project.
uuidHeader Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesRequiredapplication/json
Which week to put forward, whose it is when not the holder's own, and words for the approver.
Responses
201Createdapplication/json
The approval request, created.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the holder may not log time on the project, or names someone else without time-log:approve.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when week_start is missing or malformed, when the week holds no time, when it is already under review or approved, or when nobody is named to approve timesheets on the project.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on