v2

latestOpenAPI 3.0.0Terms and conditions2026-08-064293107.7 KB
Work Items and OKRs

Get all workspace working items and OKRs metadata by the workspace ID

get/workspace/{workspaceId}/items

Path parameters

workspaceIdstring required

Query parameters

fieldsstring

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

pagenumber double
limitnumber double

Items per page (1-500).

updated_fromstring date-time

Get list of items updated after this date (e.g. 2023-08-09T12:33:18.615Z )

updated_tostring date-time

Get list of items updated before this date (e.g. 2023-09-09T23:22:10.531Z )

typestring

Filter by item type, comma separated. Accepts canonical type names (see the 422 error for the full list) and this workspace's custom type labels (the values reads return in type). Each returned item also carries typeKey — the canonical name.

parentsstring

Filter by parent/ancestor IDs (comma separated). MUST be internal numeric IDs (e.g. 2305843010635321210), NOT shortIds like CRK-25832 — the SQL casts to ::bigint[], so a shortId yields zero matches (200 with an empty list, no error). To resolve a shortId first, call the same list endpoint with ?shortId=<KEY-N> to get the numeric id.

parentIdstring
keywordstring

Case-insensitive substring search over title + description + linked dev-tool issue keys (e.g. a Jira key like PROJ-123) + attachment metadata. Min 2 chars; shorter values are ignored.

shortIdstring

Exact match on textual short id (e.g. CRK-20091). When supplied, takes precedence over keyword and resolves via the (ct_craft_product__id, short_id) unique index — sub-millisecond, returns at most one item.

devToolKeystring

Exact match on a linked dev-tool issue key — Jira, Azure DevOps, or another connected integration (e.g. EP-402). Strongly consistent: resolves against the link tables' key unique indexes, so it finds every linked item — unlike keyword, which only carries a dev key after the item's title/description is edited after linking and therefore misses linked-but-unedited items. Case-sensitive (keys are stored upper-case). Combines with other filters (status, type, …).

statusstring
importancestring
assigneestring
sprintstring
quarterstring
labelsstring
createdBystring
created_fromstring date-time
created_tostring date-time
customFieldsstring

Response

List of workspace items, OKRs and their metadata