Retrieve a work item by ID

GET/api/v1/workspaces/{slug}/projects/{project_id}/work-items/{pk}/

Retrieve details of a specific work item.

Path Parameters

pk:requiredstring

Pk.

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

Query Parameters

expand:optionalstring

Comma-separated list of related fields to expand in response

external_id:optionalstring

External system identifier for filtering or lookup

external_source:optionalstring

External system source name for filtering or lookup

fields:optionalstring

Comma-separated list of fields to include in response

order_by:optionalstring

Field to order results by. Prefix with '-' for descending order

Scopes

projects.work_items:read

Retrieve a work item by ID

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/?expand=assignees&external_id=1234567890" \
  -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/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/?expand=assignees&external_id=1234567890",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440000/?expand=assignees&external_id=1234567890",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key",
    },
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "description": "Example description",
  "sequence_id": 1,
  "priority": "high",
  "assignees": ["550e8400-e29b-41d4-a716-446655440000"],
  "labels": ["550e8400-e29b-41d4-a716-446655440000"],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}