Advanced search work items

POST/api/v1/workspaces/{slug}/work-items/advanced-search/

Search for work items with advanced filters and search query.

Path Parameters

slug:requiredstring

Workspace slug

Body Parameters

query:optionalstring

Search query string for text-based search across issue fields

filters:optionalobject

Filter JSON passed through to IssueFilterSet for validation and application

limit:optionalinteger

Maximum number of results to return

workspace_search:optionalboolean

Whether to search across all projects in the workspace

project_id:optionalstring

Optional project ID to filter results to a specific project

Scopes

API key authentication or an OAuth token with equivalent access.

Advanced search work items

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/advanced-search/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "login",
  "project_id": "550e8400-e29b-41d4-a716-446655440000",
  "limit": 10
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/advanced-search/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "query": "login",
      "project_id": "550e8400-e29b-41d4-a716-446655440000",
      "limit": 10
    }
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/work-items/advanced-search/", {
  method: "POST",
  headers: {
    "X-API-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "login",
    project_id: "550e8400-e29b-41d4-a716-446655440000",
    limit: 10,
  }),
});
const data = await response.json();

Response200

[
  [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "sequence_id": 102,
      "project_identifier": "WEB",
      "project_id": "550e8400-e29b-41d4-a716-446655440000",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
      "type_id": "550e8400-e29b-41d4-a716-446655440000",
      "state_id": "550e8400-e29b-41d4-a716-446655440000",
      "priority": "high",
      "target_date": "2024-01-01",
      "start_date": "2024-01-01"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "sequence_id": 245,
      "project_identifier": "API",
      "project_id": "550e8400-e29b-41d4-a716-446655440000",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
      "type_id": "550e8400-e29b-41d4-a716-446655440000",
      "state_id": "550e8400-e29b-41d4-a716-446655440000",
      "priority": "medium",
      "target_date": null,
      "start_date": "2024-01-01"
    }
  ]
]