CRcraft
Work Items and OKRs

GET /item/{itemId}/flat

Changed on

Get a specific work item metadata by its ID (flattened format)

Request

  • Base URL
    https://api.craft.io
  • URL
    https://api.craft.io/item/{itemId}/flat
  • Auth
    API key in header x-api-key

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

When the item last changed in a way a person can see — the date of its latest activity-log entry. Machine touches that change nothing a reader would notice (integration sync passes, aggregation and inheritance recalculations, bulk maintenance) do not move it. Items whose last change predates this being recorded report the raw row-update date instead.

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.

status_idstring
status_namestring
importance_idstring
importance_namestring
objective_idstring
objective_namestring
keyResult_idstring
keyResult_namestring
persona_idstring
persona_namestring
sprint_idstring
sprint_namestring
quarter_idstring
quarter_namestring
assignee_idstring
assignee_teamstring
assignee_userstring
parent_idstring nullable
parent_namestring nullable
parent_shortIdstring nullable
devToolKey_jirastring
devToolKey_adostring
devToolKey_githubstring
devToolKey_gitlabstring
devToolKey_pivotaltrackerstring
devToolKey_targetprocessstring
sprint_startDatestring nullable
sprint_endDatestring nullable
quarter_startDatestring nullable
quarter_endDatestring nullable

Changes

  • 6009bb084cb5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status