Version
POST

Restore a version

/v1/timesheets/{timesheet}/revisions/{revision}/restore in the Timesheets API.

curl -X POST https://api.example.test/v1/timesheets/$TIMESHEET_ID/revisions/$REVISION_ID/restore \  -H "Authorization: Bearer $TOKEN" \  -H "Idempotency-Key: 8e2f4a6c-1b3d-4f5a-9c7e-3d5f7b9a1c2e"

Puts an earlier version of a week back, which writes a new version pointing at the one restored and emits timesheet.restored. The logs are not part of a version; a restore never locks or unlocks them.

POST
/v1/timesheets/{timesheet}/revisions/{revision}/restore

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.

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
AuthorizationBearer <token>

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

timesheet*string

The timesheet.

Formatuuid
revision*string

The version to restore.

Formatuuid

Header Parameters

Idempotency-Key*string

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.

Formatuuid

Responses

201Created

The version written by the restore, created.

400Bad request

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).

403Forbidden

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 role does not carry time-log:approve.

404Not found

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. On this endpoint: RESOURCE_NOT_FOUND: when the version belongs to another record.

409Conflict

The key was already used in the last 24 hours with a different request body.

422Validation failed

When the version is identical to the record as it stands.

425Too early

The first request with this key is still running; retry in a few seconds and the original response is replayed.

429Too many requests

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