Retrieve a work item by identifier

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

Retrieves the details of a work item using its readable identifier (e.g., PROJ-123).

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.

identifier:requiredstring

Work item identifier in the format PROJECT-123 (e.g., ENG-123)

Query Parameters

expand:optionalstring

Comma-separated list of fields to expand. Possible values: type, module, labels, assignees, state, project.

Retrieve a work item by identifier

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/{identifier}/" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/{identifier}/",
    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/{identifier}/",
  {
    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"
}