List workspace work item properties

GET/api/v2/workspaces/{slug}/work-item-properties/

Return the workspace's custom property catalog as a paginated list. Use it to resolve a property name to the id you need when creating a context or attaching the property to a work item type, or to build a picker that stays in sync with what the workspace has defined.

The list is the whole catalog, including properties that have no context yet and therefore do not appear on any work item. Reads here are unaffected by the workspace's work item type mode.

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.

Query parameters

Filters combine with AND. There is no search.

name:optionalstring

Return properties whose name slug matches, compared case-insensitively. ?name=story-points matches the property whose display_name is Story Points.

display_name:optionalstring

Return properties whose display_name matches, compared case-insensitively. ?display_name=severity matches Severity.

external_id:optionalstring

Return properties whose external_id matches exactly. Use it to find the property you created earlier for a field in another system.

external_source:optionalstring

Return properties from one source system, for example jira. Combine it with external_id, because an external_id is unique only within its source.

Check your spelling on order_by and paginate. Neither is validated: an unrecognized order_by falls back to the default ordering, and anything other than paginate=cursor uses offset pagination. A typo shows up as an unexpected sort order or envelope, not as an error.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

sort_order , -sort_order: the display order Plane uses for the property list. Use this order when rendering a form. sort_order itself is not returned on the property object.
created_at , -created_at: when each property was created
id , -id

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Read the next value from the response rather than computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope (no COUNT query), which returns next_cursor and has_more instead of next and total_count. Omit it for the default offset envelope.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count; the field is then omitted from the response.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. 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

workspaces.work_item_properties: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 workspace work item properties.
`404`	`not_found`	No such workspace, or it's outside your tenant.
`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.

List workspace properties

bash

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-properties/?order_by=sort_order&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

python

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/work-item-properties/",
    headers={"X-Api-Key": "your-api-key"},
    params={"order_by": "sort_order", "per_page": 50},
)
print(response.json())

javascript

const params = new URLSearchParams({ order_by: "sort_order", per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/work-item-properties/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

json

{
  "data": [
    {
      "id": "a7e3f1d0-5c92-4b68-8f31-2d4a6b9e0c15",
      "name": "severity",
      "display_name": "Severity",
      "description": "How badly the customer is affected",
      "property_type": "OPTION",
      "relation_type": null,
      "is_required": true,
      "is_multi": false,
      "is_active": true,
      "default_value": ["Major"],
      "options": [
        {
          "id": "9d2c7b41-6a80-4f35-8e19-5c3b0a7d2e46",
          "name": "Critical",
          "description": "Production is down",
          "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": "5a83e0b7-2c46-4d19-9f70-6b12c8e5a03d",
          "name": "Major",
          "description": "A core workflow is broken",
          "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"
        }
      ],
      "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
    },
    {
      "id": "c58b2e94-71a3-4d0f-9e62-4a1c7f38b5d2",
      "name": "reviewer",
      "display_name": "Reviewer",
      "description": "Who signs off before release",
      "property_type": "RELATION",
      "relation_type": "USER",
      "is_required": false,
      "is_multi": true,
      "is_active": true,
      "default_value": [],
      "options": [],
      "settings": {},
      "validation_rules": {},
      "logo_props": {},
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:23:12.904551Z",
      "updated_at": "2026-01-14T09:23:12.904551Z",
      "updated_by_id": null
    },
    {
      "id": "3fb6c0d8-4e21-49a7-b5c3-90ad72e14f6b",
      "name": "rollout_date",
      "display_name": "Rollout date",
      "description": "When the fix reaches customers",
      "property_type": "DATETIME",
      "relation_type": null,
      "is_required": false,
      "is_multi": false,
      "is_active": true,
      "default_value": [],
      "options": [],
      "settings": {},
      "validation_rules": {},
      "logo_props": {},
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:24:03.112884Z",
      "updated_at": "2026-01-14T09:24:03.112884Z",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 3,
  "pagination": {
    "style": "offset"
  }
}

Response200

json

{
  "data": [
    {
      "id": "a7e3f1d0-5c92-4b68-8f31-2d4a6b9e0c15",
      "name": "severity",
      "display_name": "Severity",
      "description": "How badly the customer is affected",
      "property_type": "OPTION",
      "relation_type": null,
      "is_required": true,
      "is_multi": false,
      "is_active": true,
      "default_value": ["Major"],
      "options": [],
      "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
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}

Match on id, not label

display_name is a label humans edit. Resolve it to id once and store the id, because contexts, type attachments, and property values refer to the id.

List workspace work item properties ​

Path parameters ​

Query parameters ​

Ordering ​

Pagination ​

Response shaping ​

Scopes ​

Errors ​