Clock out and close a shift
Closes the shift, stores the optional note, and returns the final shift with its worked and break totals. Requires a workspace member with `time_entries:write` and the `time_tracking_v1` control enabled, and only the person on shift may control it. An unknown shift is reported as not found and a shift that has already ended is refused as a transition conflict.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/shifts/string/clock-out" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "shift": { "id": "string", "workspaceId": "string", "userId": "string", "userDisplayName": "string", "status": "open", "startedAt": "string", "endedAt": "string", "breakStartedAt": "string", "accumulatedBreakMs": 0, "workedMs": 0, "closedBy": "user", "note": "string", "createdByUserId": "string", "updatedByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "serverTime": "string", "authoritativeWorkedMs": 0 }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}End a break and resume the shift
Returns the shift to `open`, adds the break to its accumulated break time, and resumes the timer the break interrupted if that timer is still paused. Requires a workspace member with `time_entries:write` and the `time_tracking_v1` control enabled, and only the person on shift may control it. An unknown shift is reported as not found; a shift already open is returned unchanged, and any other state is refused as a transition conflict.
List the tool catalog available in a workspace
Returns a descriptor for every tool the caller may run in this workspace: its name, description, stake level, required permission, audiences, and input schema. Requires a workspace member with the `ai:read` permission, and tools whose own permission the actor lacks are omitted rather than listed.