Search work items

GET/api/v1/workspaces/{workspace_slug}/work-items/search/

Searches for work items across a workspace by text query.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

Query Parameters

search:requiredstring

Text query to search for in work item names and descriptions.

project:optionalstring

Filter results to a specific project by ID.

Scopes

projects.work_items:read

Search work items

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/", {
  method: "GET",
  headers: {
    "X-API-Key": "your-api-key",
  },
});
const data = await response.json();

Response200

{
  "id": "work-item-uuid",
  "name": "Work Item Title",
  "state": "state-uuid",
  "priority": 2,
  "created_at": "2024-01-01T00:00:00Z"
}