Search work items

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

Perform semantic search across issue names, sequence IDs, and project identifiers.

Path Parameters

slug:requiredstring

Workspace slug

Query Parameters

limit:optionalinteger

Maximum number of results to return

project_id:optionalstring

Project ID for filtering results within a specific project

search:requiredstring

Search query to filter results by name, description, or identifier

workspace_search:optionalstring

Whether to search across entire workspace or within specific project

Scopes

projects.work_items:read

Search work items

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/search/?limit=10&project_id=550e8400-e29b-41d4-a716-446655440000" \
  -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/?limit=10&project_id=550e8400-e29b-41d4-a716-446655440000",
    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/?limit=10&project_id=550e8400-e29b-41d4-a716-446655440000",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key",
    },
  }
);
const data = await response.json();

Response200

{
  "issues": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "sequence_id": 123,
      "project__identifier": "MAB",
      "project_id": "550e8400-e29b-41d4-a716-446655440000",
      "workspace__slug": "my-workspace"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "sequence_id": 124,
      "project__identifier": "MAB",
      "project_id": "550e8400-e29b-41d4-a716-446655440000",
      "workspace__slug": "my-workspace"
    }
  ]
}