Skip to content

List an initiative's work items ​

GET/api/v2/workspaces/{slug}/initiatives/{pk}/work-items/

Return the work items on an initiative as full work item objects, paginated. You get the association and the rows behind it in one call, so you don't have to look up each work item by id. Work items of any type come back, epics included, and they can belong to any project in the workspace.

The list checks the initiative first, then each work item's own visibility. An initiative you can't see returns 404. Work items you can't see are left out of the page. Archived work items, drafts, and work items in archived projects are also left out.

This is the read half of the route. To change what is on the initiative, POST to the same path, as described in Add or remove initiative work items.

Need to filter? Use the work items list

This list takes no filters, no search, and no order_by. To combine the initiative with other conditions, pass initiative_id to List work items or List work items across a workspace instead. For example, ?initiative_id=9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88&state_group=started returns the initiative's work items that are in progress, with the full filter, ordering, and cursor pagination of that list.

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The initiative whose work items you want to list.

Ordering ​

Rows come back in a fixed order, newest first by each work item's created_at, with id as the tiebreaker. The order is not configurable, and an order_by you send is ignored.

Pagination ​

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Read the next value from the response rather than computing offsets yourself.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping ​

fields and expand apply to the work item rows, not to the initiative.

fields:optionalstring

Comma-separated list of fields to return on each row. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: archived_at, assignee_ids, completed_at, created_at, created_by_id, cycle_id, description_html, estimate_point_id, external_id, external_source, id, identifier, is_draft, label_ids, module_ids, name, parent_id, priority, project_id, sequence_id, sort_order, start_date, state_id, target_date, type_id, updated_at, updated_by_id.

description_html is left off the rows by default. Name it in fields to get it back. custom_fields is not available on this list. Fetch a single work item with Get a work item to read it.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: assignees (the assigned users), cycle (the cycle it belongs to), estimate_point (its estimate point), labels (the applied labels), modules (the modules it belongs to), parent (its parent work item), state (the work item's state object), type (its work item type).

Expansion is separate-key: ?expand=state keeps state_id and adds a state object next to it, so an id is never replaced by an object. An unknown value is a 400.

?fields= and ?expand= are independent namespaces. Relation names are not valid ?fields= tokens (and vice versa), and an expanded object survives field filtering. ?fields=id,name&expand=state returns id, name and state. See Expanding relations.

Scopes ​

initiatives:read

Errors ​

StatusCodeCause
400invalid_requestAn unknown name in fields or expand.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan or is switched off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such initiative, you can't see it, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List an initiative's work items
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/initiatives/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/?per_page=50&expand=state" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
      "name": "Fix login redirect loop",
      "identifier": "PROJ-142",
      "sequence_id": 142,
      "priority": "high",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "type_id": "2d9d1a97-5c6f-4a1e-9d5b-8c2f7e30b6a4",
      "assignee_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
      "label_ids": ["c1b8f3d6-9a44-4e12-8f7a-2b6d5c9e1a03"],
      "cycle_id": "e3a71c52-8d4f-4b19-a6e0-5f2c9d8b1a74",
      "module_ids": [],
      "parent_id": null,
      "estimate_point_id": null,
      "start_date": "2026-01-12",
      "target_date": "2026-01-20",
      "is_draft": false,
      "sort_order": 65535.0,
      "completed_at": null,
      "archived_at": null,
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-15T11:03:27.115902Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "state": {
        "id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
        "name": "In Progress",
        "color": "#3f76ff",
        "group": "started"
      }
    },
    {
      "id": "5d2e8a61-7b39-4c04-9f18-3a6c1e9b4d70",
      "name": "Offline mode for the mobile app",
      "identifier": "MOB-37",
      "sequence_id": 37,
      "priority": "medium",
      "project_id": "a51e8c37-2f94-4d06-b8c1-7e3d0a6f9b25",
      "state_id": "0b9e4d27-6a13-4f85-8c2d-1e7a5f3b9c06",
      "type_id": "7a3c1e58-0f62-4b9d-a4e7-2d8b6c0f1e93",
      "assignee_ids": [],
      "label_ids": [],
      "cycle_id": null,
      "module_ids": ["d4b80f2a-6e17-4c39-b5a1-9f3e2c7d8a64"],
      "parent_id": null,
      "estimate_point_id": null,
      "start_date": null,
      "target_date": "2026-03-31",
      "is_draft": false,
      "sort_order": 131070.0,
      "completed_at": null,
      "archived_at": null,
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-09T14:51:08.604217Z",
      "updated_at": "2026-01-09T14:51:08.604217Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "state": {
        "id": "0b9e4d27-6a13-4f85-8c2d-1e7a5f3b9c06",
        "name": "Todo",
        "color": "#a3a3a3",
        "group": "unstarted"
      }
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}