Feature · Work
Work item
A work item is one piece of work with an owner, a state, a plan, checks and evidence. Each one has a key such as AGT-12.
How it works
What a work item holds
- a key, for example
AGT-12, a title and an objective; - an owner: a worker or a person;
- a priority: Urgent, High, Normal or Low;
- requirements, acceptance criteria and a plan;
- checks and evidence; see Evidence and checks;
- a thread for messages, and its cost.
States
New, Triaged, Planning, In progress, Waiting, Blocked, Verifying, In review, Changes requested, Done, Failed and Cancelled.
Detail levels
A work item opens on Summary. Five levels show more or less:
- Glance: the state, what needs a person and the work in progress.
- Summary: the task checklist, the state and the communications.
- Proof: tests and results, live calls, screenshots and waivers.
- Changes: files changed, diffs, commits and review threads.
- Internals: agents, plans, the decision log, model calls, costs and the raw trace.
Actions
Members can select Assign…, Hand off, Block, Resume, Reopen and Cancel item. Each action asks for a reason. Cancelling an item also cancels the approvals that wait on it.
Create work
From the help article Work items, checked against the product on .
What you can do
The operations this feature's screens call. Each one is POST /api/<name>, and the badge says who may call it.
ViewergetWorkItemGets the work item.
Types:
GetWorkItemRequestreturnsGetWorkItemResponse
ViewergetWorkItemFastPathGets the work item fast path.
Types:
GetWorkItemFastPathRequestreturnsGetWorkItemFastPathResponse
ViewerlistThreadsLists threads.
Types:
ListThreadsRequestreturnsPageResponse<ThreadDto>
ViewerlistWorkersLists workers.
Types:
ListWorkersRequestreturnsListResponse<WorkerSummary>
ViewerlistMembersLists members.
Types:
EmptyRequestreturnsListMembersResponse
ViewerlistWorkItemsLists work items.
Types:
ListWorkItemsRequestreturnsPageResponse<WorkItemSummary>
MembergiveFeedbackGives feedback.
Types:
GiveFeedbackRequestreturnsFeedbackDto
ViewergetDocumentRevisionGets the document revision.
Types:
GetDocumentRevisionRequestreturnsDocumentRevisionDto
ViewerlistDeliveryProofsLists delivery proofs.
Types:
ListDeliveryProofsRequestreturnsListDeliveryProofsResponse
MemberholdCampaignStop and wait: hold the item and everything under it. Schedules, timers and delegation start no held work.
Types:
CampaignHoldRequestreturnsCampaignDto
MemberreleaseCampaignLift a hold and wake the open items under it.
Types:
CampaignRefreturnsCampaignDto
MembersteerCampaignSend one instruction to every open item in the campaign, for example "keep going but open fewer pull requests".
Types:
CampaignSteerRequestreturnsCampaignSteerResult
AdminsetCampaignSettingsSet the campaign limits (concurrency, total items, spend), delivery mode and pull request limits.
Types:
CampaignSettingsRequestreturnsCampaignDto
ViewergetCampaignReportWhat the campaign did: items by role, runs, pull requests merged and declined, lines changed, cost and follow-ups.
Types:
CampaignRefreturnsCampaignReportDto
ViewergetWorkItemRoutingGets work item routing.
Types:
GetWorkItemRoutingRequestreturnsWorkItemRoutingDto
MembersetWorkItemRoutingOverrideSets the work item routing override.
Types:
SetWorkItemRoutingOverrideRequestreturnsWorkItemRoutingDto
MembersetStepRoutingOverrideSets the step routing override.
Types:
SetStepRoutingOverrideRequestreturnsWorkItemRoutingDto
ViewergetRunModeGets the run mode.
Types:
GetRunModeRequestreturnsRunModeDto
MembersetWorkItemRunModeSets the work item run mode.
Types:
SetWorkItemRunModeRequestreturnsRunModeDto
MemberupdateWorkItemUpdates the work item.
Types:
UpdateWorkItemRequestreturnsWorkItemDetail
MembertransitionWorkItemMoves the work item.
Types:
TransitionWorkItemRequestreturnsWorkItemDetail
ViewerexplainActionExplains the action.
Types:
ExplainActionRequestreturnsExplainActionResponse
ViewerexplainDecisionExplains the decision.
Types:
ExplainDecisionRequestreturnsExplainDecisionResponse
ViewerlistEventsLists events.
Types:
ListEventsRequestreturnsPageResponse<AuditEvent>
ViewergetContextManifestGets the context manifest.
Types:
GetContextManifestRequestreturnsGetContextManifestResponse
ViewergetWorkItemModelCallsGets work item model calls.
Types:
GetWorkItemModelCallsRequestreturnsPageResponse<WorkItemModelCallDto>
ViewerlistWorkItemEvidenceLists work item evidence.
Types:
ListWorkItemEvidenceRequestreturnsListResponse<WorkEvidenceDto>
ViewergetProjectFolderGets the project folder.
Types:
GetProjectFolderRequestreturnsProjectFolderView
ViewergetThreadGets the thread.
Types:
GetThreadRequestreturnsGetThreadResponse
ViewergetWorkItemTraceGets work item trace.
Types:
GetWorkItemTraceRequestreturnsGetWorkItemTraceResponse
ViewergetWorkItemActionsGets work item actions.
Types:
GetWorkItemActionsRequestreturnsListResponse<ActionDto>
ViewergetWorkItemRepositoryReadinessGets work item repository readiness.
Types:
{ workItemId: string }returnsimport('./repositoryReadiness.js').WorkItemRepositoryReadinessResponse
ViewergetWorkItemSpecThe spec attached to a work item, and the spec blocks this item implements.
Types:
{ workItemId: string }returns{ spec: SpecSummary | null; cites: Array<{ specId: string; specKey: string; blockId: string; ref: string; text: string …
MembercreateSpecWith a work item and no blocks it starts from the item: objective, requirements, plan approach, risks, open questions and recorded decisions. One spec per work item.
Types:
{ title?: string; workItemId?: string; blocks?: SpecBlockInput[]; draftWithAgent?: boolean }returns{ spec: SpecDetail; agentAsked: boolean; reason: string | null }
MemberNo API tokensreviewWorkDecisionReviews the work decision.
Types:
import('./workDecisions.js').ReviewWorkDecisionRequestreturns{ decision: import('./domain.js').DecisionRecord }
ViewergetWorkItemContextGets work item context.
Types:
GetWorkItemContextRequestreturnsWorkItemContextDto
ViewergetDelegateLogGets the delegate log.
Types:
GetDelegateLogRequestreturnsDelegateLogPageDto
MemberNo API tokensgetWorkItemReplayRetentionGets the work item replay retention.
Types:
{ workItemId: string }returnsimport('./modelReplay.js').SetWorkItemReplayRetentionResponse
MemberNo API tokenssetWorkItemReplayRetentionSets the work item replay retention.
Types:
import('./modelReplay.js').SetWorkItemReplayRetentionRequestreturnsimport('./modelReplay.js').SetWorkItemReplayRetentionResponse
MemberNo API tokensgetWorkItemModelReplayGets work item model replay.
Types:
import('./modelReplay.js').GetWorkItemModelReplayRequestreturnsimport('./modelReplay.js').GetWorkItemModelReplayResponse
ViewergetPreferencesGets preferences.
Types:
GetPreferencesRequestreturnsPreferencesView
ViewerNo API tokensupdateMyPreferencesUpdates my preferences.
Types:
UpdateMyPreferencesRequestreturnsPreferencesView
MemberlistReviewNotesLists review notes.
Types:
{ workItemId?: string; threadId?: string; reviewerWorkerId?: string; includeSilent?: boolean; limit?: number }returns{ notes: ReviewNoteDto[] }
MemberresolveReviewNoteResolves the review note.
Types:
{ noteId: string; verdicts: ReviewVerdictInput[] }returnsReviewNoteDto
ViewerlistWorkItemDecisionsLists work item decisions.
Types:
ListWorkItemDecisionsRequestreturnsListWorkItemDecisionsResponse
ViewerlistDeliverySourceReceiptsLists delivery source receipts.
Types:
ListDeliverySourceReceiptsRequestreturnsListDeliverySourceReceiptsResponse
ViewergetDeliverySubjectRecordGets the delivery subject record.
Types:
GetDeliverySubjectRecordRequestreturnsDeliverySubjectRecordDto
ViewergetDocumentGets the document.
Types:
GetDocumentRequestreturnsDocumentDto
ViewerlistDocumentRevisionsLists document revisions.
Types:
ListDocumentRevisionsRequestreturnsListDocumentRevisionsResponse
MemberupdateDocumentUpdates the document.
Types:
UpdateDocumentRequestreturnsUpdateDocumentResponse
AdmindeleteDocumentRemoves the document and its chunks from search; the audit log keeps the record of it and of the removal.
Types:
DeleteDocumentRequestreturnsOkResponse
ViewerlistWorkItemChecksLists work item checks.
Types:
ListWorkItemChecksRequestreturnsListWorkItemChecksResponse
MemberpostWorkItemMessagePosts the work item message.
Types:
PostWorkItemMessageRequestreturnsMessageDto
MemberpostMessagePosts the message.
Types:
PostMessageRequestreturnsMessageDto
AnyoneNo API tokenscreateAnotherOrgAnother organization of the signed-in person's own, whatever orgs they belong to: sign-up's name check, budget and allowance, the allowance pooled with every org their inbox created. The session switches to it.
Types:
CreateAnotherOrgRequestreturnsCreateOrgResponse
ViewerlistAtlasRepositoriesLists atlas repositories.
Types:
Record<string, never>returns{ items: AtlasRepositorySummary[]; settings: AtlasSettings }
ViewergetAtlasRepositoryGets the atlas repository.
Types:
{ id: string; scanId?: string }returns{ repository: AtlasRepositorySummary; scan: AtlasScanRef; profile: AtlasProfile; history: AtlasScanRef[]; findingWork: …
ViewerdiffAtlasScansCompares atlas scans.
Types:
{ id: string; fromScanId: string; toScanId?: string }returns{ from: AtlasScanRef; to: AtlasScanRef; diff: AtlasProfileDiff }
MembersubmitAtlasProfilesSubmits atlas profiles.
Types:
{ profiles: AtlasProfile[] }returnsAtlasSubmitResult
AdminremoveAtlasRepositoryRemoves the atlas repository.
Types:
{ id: string }returns{ removed: boolean }
ViewergetAtlasWorkOverlayGets the atlas work overlay.
Types:
{ workItemId: string }returnsAtlasWorkOverlay
ViewerprobeAtlasRepositoryChecks the public health routes the latest profile names. Results are cached for a minute.
Types:
{ id: string }returns{ probes: AtlasProbe[]; targets: number }
AdminNo API tokensupdateAtlasSettingsAdmins turn the platform's own refresh (a scan of each checkout it prepares for work) on or off.
Types:
{ autoRefresh: boolean }returnsAtlasSettings
ViewerlistDocumentCommentsLists document comments.
Types:
ListDocumentCommentsRequestreturnsListDocumentCommentsResponse
MembercreateDocumentCommentCreates a document comment.
Types:
CreateDocumentCommentRequestreturnsCreateDocumentCommentResponse
MemberdeleteDocumentCommentDeletes the document comment.
Types:
DeleteDocumentCommentRequestreturnsOkResponse
ViewergetWorkerInsightsGets worker insights.
Types:
GetWorkerInsightsRequestreturnsWorkerInsightsResponse
Screens
/work/:id
What it records
The feature writes these events to the audit log, the permanent record of what happened.
- Delegate ended
- Policy changed
- Project decision recorded
- Project decision retired
- Project decision superseded
- Review note recorded
- Review participant changed
- Review points resolved
- Shared output changed