Sign in
Work Items and OKRs

Get a specific work item metadata by its ID

get/item/{itemId}

Path parameters

itemIdstring required

Query parameters

fieldsstring

Comma separated field list to be included in response, set "all" for all fields

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

Changes

Changed in 1 of the 3 revisions of this API.1

  • df0d980eb1e31See the full diff
    • ○

      added the optional property assignee/allOf[Assignee]/userId to the response with the 200 status

      response-optional-property-added