Get a type property

GET/api/v2/workspaces/{slug}/projects/{project_id}/work-item-types/{type_id}/properties/{pk}/

Retrieve a single property as exposed by a work item type. The response is the full property definition, the same object List type properties returns, for one id.

The type in the path is part of the lookup: a property that exists in the project but is not attached to this type returns 404. That makes this endpoint a cheap "is this property on this type?" check before you send a value or offer the field in a form.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring (uuid)

The project the work item type belongs to.

type_id:requiredstring (uuid)

The work item type the property is attached to.

pk:requiredstring (uuid)

The id of the property to retrieve. This is the property's own id, the same value you pass to attach and detach it.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: created_at, default_value, description, display_name, external_id, external_source, id, is_active, is_multi, is_required, logo_props, name, options, property_type, relation_type, settings, updated_at, updated_by_id, validation_rules.

See Sparse fields.

Scopes

projects.work_item_types:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your role or token scope can't read this project's work item types.
404	not_found	No such workspace, project, type, or property, or the property isn't attached to this type.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

A 404 here can mean "not attached"

The property may exist but not be linked to this type. Read it without the type in the path using Get a work item property to tell the two cases apart, or list the type's properties to see what it exposes.

One flat object, readable in either mode

The response is the flat property object shown here, with options already inlined for OPTION properties, so there is nothing to fetch separately. Reads also work in either work item type mode; only attaching and detaching depend on the mode. See Work item type modes.

Get a type property

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/9d3c7f21-6b48-4e0a-8f52-2c1d7a904e66/properties/c1f0a2d4-73b9-4e6c-8a15-9d0e4b3f7c28/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/9d3c7f21-6b48-4e0a-8f52-2c1d7a904e66/properties/c1f0a2d4-73b9-4e6c-8a15-9d0e4b3f7c28/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/9d3c7f21-6b48-4e0a-8f52-2c1d7a904e66/properties/c1f0a2d4-73b9-4e6c-8a15-9d0e4b3f7c28/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "c1f0a2d4-73b9-4e6c-8a15-9d0e4b3f7c28",
  "name": "severity",
  "display_name": "Severity",
  "description": "How badly this bug affects users",
  "property_type": "OPTION",
  "relation_type": null,
  "is_required": true,
  "is_multi": false,
  "is_active": true,
  "default_value": [],
  "settings": {},
  "validation_rules": {},
  "logo_props": {},
  "external_id": null,
  "external_source": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "updated_by_id": null,
  "options": [
    {
      "id": "3b6f1c88-0d24-4a97-9f53-71e8c2b4a069",
      "name": "Critical",
      "description": "Data loss or full outage",
      "parent_id": null,
      "is_default": false,
      "is_active": true,
      "sort_order": 10000,
      "logo_props": {},
      "external_id": null,
      "external_source": null,
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    },
    {
      "id": "7e2a9046-5c31-4d8b-a4f6-0b95e13d72c8",
      "name": "Major",
      "description": "Core workflow blocked",
      "parent_id": null,
      "is_default": true,
      "is_active": true,
      "sort_order": 20000,
      "logo_props": {},
      "external_id": null,
      "external_source": null,
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ]
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}