Get work item with properties

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

Retrieve a work item with all standard fields and custom properties.

Returns a consolidated response where:

• Standard fields use _id suffix (state_id, project_id, etc.)
• Custom properties are included as custom_field_<name> keys
• Each custom field contains: id, type, name, display_name, is_required, is_multi, value, value_detail

Custom properties are only included if the ISSUE_TYPES feature is enabled for the workspace.

Path Parameters

issue_id:requiredstring

Issue ID

pk:requiredstring

Pk.

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

Scopes

projects.work_items:read

Get work item with properties

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/properties/" \
  -H "X-API-Key: $PLANE_API_KEY"

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/properties/",
    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/properties/",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key",
    },
  }
);
const data = await response.json();

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "sequence_id": 1,
  "description_html": "<p>Example content</p>",
  "description_stripped": "Example description",
  "state_id": "550e8400-e29b-41d4-a716-446655440000",
  "priority": "urgent",
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
  "project_id": "550e8400-e29b-41d4-a716-446655440000",
  "parent_id": "550e8400-e29b-41d4-a716-446655440000",
  "type_id": "550e8400-e29b-41d4-a716-446655440000",
  "estimate_point_id": "550e8400-e29b-41d4-a716-446655440000"
}