Work Items and OKRs
Create a work item
post/item
Request body
typestring required
workspaceIdstring
portfolioIdstring
titlestring required
descriptionstring nullable
storyPointsnumber double nullable
initiativeIdstring nullable
valuenumber double nullable
effortnumber double nullable
kanostring nullable
estimatedHoursnumber double nullable
labelsstring[]
actualStartDatestring date-time nullable
actualEndDatestring date-time nullable
{"stackTrail":"components:schemas:ItemCreate:properties:assignee","oasType":"schema","type":"unknown","description":"`null` to unassign, or an object `{ team: \"<team name>\" }` (team required)\r\nwith optional `user: \"<member email>\"` to assign a specific person — shape\r\nmatches the read-side `assignee` object (the `Assignee` component). Typed\r\n`unknown` on purpose: the shape is validated by assertAssignee so every wrong\r\nshape gets one clear message instead of a raw tsoa union error.","example":{"team":"Team A","user":"a@b.com"}}
Example request
{
"assignee": {
"team": "Team A",
"user": "a@b.com"
}
}Response
The item’s metadata
idstring nullable
typestring
Workspace-facing type label — the workspace's custom terminology (e.g. "Subtask").
typeKeystring
Canonical type name (requirement/feature/idea/task/bug/epic/product/story/…) — the value the type filter and write endpoints accept, independent of workspace terminology.
workspaceIdstring
portfolioIdstring
shortIdstring
titlestring
descriptionstring nullable
creationTimestring date-time
updateTimestring date-time
storyPointsnumber double
initiativeIdstring nullable
valuenumber double
effortnumber double
kanostring
estimatedHoursnumber double
labelsstring[]
actualStartDatestring date-time nullable
actualEndDatestring date-time nullable
webUrlstring
Canonical Craft.io app URL for this item. Computed in PublishService.
commentCountnumber double