Retrieve a work item by identifier

GET/api/v1/workspaces/{workspace_slug}/work-items/{project_identifier}-{issue_identifier}/

Retrieve a specific work item using workspace slug, project identifier, and issue identifier.

Path Parameters

issue_identifier:requiredinteger

The numeric issue identifier.

project_identifier:requiredstring

The project identifier key.

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.

Scopes

projects.work_items:read

Retrieve a work item by identifier

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/work-items/PROJ-123/" \
  -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/PROJ-123/",
    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/PROJ-123/", {
  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"
}