List a customer's work items

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

Return the work items linked to a customer as full work item objects, paginated. You get the link and the rows behind it in one call, so you don't have to look up each work item by id.

A work item can be linked to a customer in two ways. A direct link comes from Link or unlink customer work items. A request link comes from the work_item_ids of one of the customer's requests. This list returns both. A work item linked more than once, for example directly and through a request, appears once.

The list checks the customer first, then each work item's own visibility. A customer that doesn't exist in the workspace 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 link or unlink work items, POST to the same path, as described in Link or unlink customer work items.

Need to filter? Use the work items list

Apart from customer_request_id, this list takes no filters, no search, and no order_by. To combine the customer with other conditions, pass customer_id to List work items or List work items across a workspace instead. That filter matches the same set of work items, direct links and request links alike, and combines with the rest of that list's filters, for example ?customer_id=9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88&state_group=completed.

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 customer whose work items you want to list.

Query Parameters

customer_request_id:optionalstring (uuid)

Return only the work items linked through this customer request. Direct links are left out when you pass it. An id that names no request on this customer returns an empty list, not every work item. A value that isn't a valid UUID returns 400 invalid_request.

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 customer.

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

customers:read

Errors

Status	Code	Cause
400	invalid_request	customer_request_id isn't a valid UUID, or fields or expand names an unknown value.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Customers aren't included in your plan.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such customer, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List a customer's work items

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/?customer_request_id=b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/",
    headers={"X-Api-Key": "your-api-key"},
    params={"customer_request_id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53"},
)
print(response.json())

const params = new URLSearchParams({
  customer_request_id: "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
});
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/customers/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/work-items/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
      "name": "Support SAML single sign-on",
      "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": [],
      "cycle_id": "e3a71c52-8d4f-4b19-a6e0-5f2c9d8b1a74",
      "module_ids": [],
      "parent_id": null,
      "estimate_point_id": null,
      "start_date": "2026-01-12",
      "target_date": "2026-02-27",
      "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"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 1,
  "pagination": {
    "style": "offset"
  }
}

Response400

{
  "type": "invalid_request",
  "code": "invalid_request",
  "detail": "One or more fields failed validation.",
  "errors": [
    {
      "field": "customer_request_id",
      "code": "invalid",
      "message": "Must be a valid UUID."
    }
  ]
}