Overview

Custom properties add fields to work items that are specific to your workflow and processes.

Learn more about custom properties

The properties object

Attributes

• workspace uuid

  The workspace the property belongs to. Plane sets it automatically.

• project uuid

  The project the property belongs to. Plane sets it automatically.

• created_at , updated_at timestamp

  When the property was created and when it was last updated.

• created_by & updated_by

  Set automatically to the ID of the user who created or last updated the property.

• external_id & external_source

  Your system's identifier for this record and the system it came from, for sync and import correlation.

Response200

{
  "id": "f962febb-98bc-43ca-8bfb-8012e4d54dae",
  "created_at": "2024-10-23T07:38:58.231897Z",
  "updated_at": "2024-10-23T07:38:58.231920Z",
  "deleted_at": null,
  "name": "first-issue-property",
  "display_name": "first issue property",
  "description": "first issue property",
  "logo_props": {},
  "sort_order": 75535.0,
  "property_type": "OPTION",
  "relation_type": null,
  "is_required": false,
  "default_value": [],
  "settings": {},
  "is_active": false,
  "is_multi": false,
  "validation_rules": {},
  "external_source": null,
  "external_id": null,
  "created_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4",
  "updated_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4",
  "workspace": "70b6599f-9313-4c0d-b5c0-406a13a05647",
  "project": "03a9bf56-84f4-4afe-b232-9400eb9b7b6b",
  "issue_type": "1800681a-a749-487b-9003-3279031fea35"
}