# Plane

> Track work in Plane: file work items from forms, emails and alerts, keep their state, people and labels up to date, and comment on them. Start a workflow when a work item is made.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/plane

## Actions

### Add comment

Comment on a work item.

**Inputs**

- Work item (`work_item`, text, required): The work item, such as WEB-42, or its link.
- Comment (`comment`, text, required): What to say, in plain text.

**Outputs**

- `author` (text): Who wrote it
- `comment` (text): What it says, as plain text
- `created_at` (text): When (ISO 8601)
- `id` (text): The comment's ID
- `work_item` (text): The work item, such as WEB-42

**Example output**

```json
{
  "author": "ada",
  "comment": "Fixed in the 3.2 release.",
  "created_at": "2026-10-28T10:00:00Z",
  "id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
  "work_item": "WEB-42"
}
```

### Create label

Make a label in a project.

**Inputs**

- Project (`project`, text, required): The project.
- Name (`name`, text, required): What to call it, such as Customer request.
- Colour (`color`, text): Its colour, such as #ff6900. Leave blank for Plane's default.

**Outputs**

- `color` (text): Its colour
- `id` (text): Its ID
- `name` (text): Its name

**Example output**

```json
{
  "color": "#ef4444",
  "id": "3c2b1a09-8f7e-4d6c-b5a4-938271605f4e",
  "name": "Bug"
}
```

### Create work item

Make a work item in a project, with its state, priority, people, labels and dates.

**Inputs**

- Project (`project`, text, required): The project to make it in.
- Title (`name`, text, required): The work item's title.
- Description (`description`, text): What it's about, in plain text.
- State (`state`, text): Its state, such as Todo or Done. Leave blank for the project's default.
- Priority (`priority`, text): How urgent it is. One of: `urgent`, `high`, `medium`, `low`, `none`.
- Assignees (`assignees`, list): Who works on it.
- Labels (`labels`, list): Its labels.
- Start date (`start_date`, date): When work starts.
- Due date (`target_date`, date): When it's due.

**Outputs**

- `assignees` (list): Who works on it
- `created_at` (text): When it was made (ISO 8601)
- `description` (text): What it's about, as plain text
- `id` (text): The work item's ID
- `identifier` (text): Its identifier, such as WEB-42
- `labels` (list): Its labels
- `link` (text): A link to it in Plane
- `name` (text): Its title
- `priority` (text): urgent, high, medium, low or none
- `project_id` (text): Its project's ID
- `start_date` (text): When work starts (YYYY-MM-DD)
- `state` (text): Its state, such as In Progress
- `state_group` (text): backlog, unstarted, started, completed or cancelled
- `target_date` (text): When it's due (YYYY-MM-DD)
- `updated_at` (text): When it last changed (ISO 8601)

**Example output**

```json
{
  "assignees": [
    "ada"
  ],
  "created_at": "2026-10-28T09:00:00Z",
  "description": "The submit button is hidden below the keyboard.",
  "id": "8d0f6a4e-3b1c-4d2a-9e7f-1a2b3c4d5e6f",
  "identifier": "WEB-42",
  "labels": [
    "Bug"
  ],
  "link": "https://app.plane.so/acme/browse/WEB-42/",
  "name": "Fix the sign-up form on mobile",
  "priority": "high",
  "project_id": "2c9e1f7a-5b3d-4e6f-8a1b-9c0d2e3f4a5b",
  "start_date": "2026-10-28",
  "state": "In Progress",
  "state_group": "started",
  "target_date": "2026-11-04",
  "updated_at": "2026-10-28T09:30:00Z"
}
```

### Delete label

Delete a label from a project. Work items that had it lose it.

**Inputs**

- Project (`project`, text, required): The project.
- Label (`label`, text, required): The label.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (text): The label's ID

**Example output**

```json
{
  "deleted": true,
  "id": "3c2b1a09-8f7e-4d6c-b5a4-938271605f4e"
}
```

### Delete work item

Delete a work item.

**Inputs**

- Work item (`work_item`, text, required): The work item, such as WEB-42, or its link.

**Outputs**

- `deleted` (true/false): True once deleted
- `identifier` (text): The work item deleted

**Example output**

```json
{
  "deleted": true,
  "identifier": "WEB-42"
}
```

### Get current user

Who the connection acts as in Plane.

**Inputs**: None.

**Outputs**

- `display_name` (text): Their display name
- `email` (text): Their email address
- `id` (text): Their ID
- `name` (text): Their name
- `workspace` (text): The workspace the connection works in

**Example output**

```json
{
  "display_name": "ada",
  "email": "ada@example.com",
  "id": "0b1c2d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
  "name": "Ada Lovelace",
  "workspace": "acme"
}
```

### Get work item

Get a work item, such as WEB-42, with its description, state and people.

**Inputs**

- Work item (`work_item`, text, required): The work item, such as WEB-42, or its link.

**Outputs**

- `assignees` (list): Who works on it
- `created_at` (text): When it was made (ISO 8601)
- `description` (text): What it's about, as plain text
- `id` (text): The work item's ID
- `identifier` (text): Its identifier, such as WEB-42
- `labels` (list): Its labels
- `link` (text): A link to it in Plane
- `name` (text): Its title
- `priority` (text): urgent, high, medium, low or none
- `project_id` (text): Its project's ID
- `start_date` (text): When work starts (YYYY-MM-DD)
- `state` (text): Its state, such as In Progress
- `state_group` (text): backlog, unstarted, started, completed or cancelled
- `target_date` (text): When it's due (YYYY-MM-DD)
- `updated_at` (text): When it last changed (ISO 8601)

**Example output**

```json
{
  "assignees": [
    "ada"
  ],
  "created_at": "2026-10-28T09:00:00Z",
  "description": "The submit button is hidden below the keyboard.",
  "id": "8d0f6a4e-3b1c-4d2a-9e7f-1a2b3c4d5e6f",
  "identifier": "WEB-42",
  "labels": [
    "Bug"
  ],
  "link": "https://app.plane.so/acme/browse/WEB-42/",
  "name": "Fix the sign-up form on mobile",
  "priority": "high",
  "project_id": "2c9e1f7a-5b3d-4e6f-8a1b-9c0d2e3f4a5b",
  "start_date": "2026-10-28",
  "state": "In Progress",
  "state_group": "started",
  "target_date": "2026-11-04",
  "updated_at": "2026-10-28T09:30:00Z"
}
```

### List comments

List a work item's comments, oldest first.

**Inputs**

- Work item (`work_item`, text, required): The work item, such as WEB-42, or its link.

**Outputs**

- `comments` (list): The comments
- `count` (number): How many

**Example output**

```json
{
  "comments": [
    {
      "author": "ada",
      "comment": "Fixed in the 3.2 release.",
      "created_at": "2026-10-28T10:00:00Z",
      "id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "work_item": "WEB-42"
    }
  ],
  "count": 1
}
```

### List labels

List a project's labels.

**Inputs**

- Project (`project`, text, required): The project.

**Outputs**

- `count` (number): How many
- `labels` (list): The labels

**Example output**

```json
{
  "count": 1,
  "labels": [
    {
      "color": "#ef4444",
      "id": "3c2b1a09-8f7e-4d6c-b5a4-938271605f4e",
      "name": "Bug"
    }
  ]
}
```

### List members

List the people in the workspace.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `members` (list): The people

**Example output**

```json
{
  "count": 1,
  "members": [
    {
      "display_name": "ada",
      "email": "ada@example.com",
      "id": "0b1c2d3e-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
      "name": "Ada Lovelace"
    }
  ]
}
```

### List projects

List the workspace's projects you can see.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `projects` (list): The projects

**Example output**

```json
{
  "count": 1,
  "projects": [
    {
      "description": "The marketing site",
      "id": "2c9e1f7a-5b3d-4e6f-8a1b-9c0d2e3f4a5b",
      "identifier": "WEB",
      "name": "Website"
    }
  ]
}
```

### List states

List a project's states, such as Todo and Done, in board order.

**Inputs**

- Project (`project`, text, required): The project.

**Outputs**

- `count` (number): How many
- `states` (list): The states

**Example output**

```json
{
  "count": 1,
  "states": [
    {
      "color": "#f59e0b",
      "group": "started",
      "id": "7a6b5c4d-3e2f-4a1b-8c9d-0e1f2a3b4c5d",
      "name": "In Progress"
    }
  ]
}
```

### List work items

List a project's work items, newest first.

**Inputs**

- Project (`project`, text, required): The project.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many
- `work_items` (list): The work items

**Example output**

```json
{
  "count": 1,
  "work_items": [
    {
      "assignees": [
        "ada"
      ],
      "created_at": "2026-10-28T09:00:00Z",
      "description": "The submit button is hidden below the keyboard.",
      "id": "8d0f6a4e-3b1c-4d2a-9e7f-1a2b3c4d5e6f",
      "identifier": "WEB-42",
      "labels": [
        "Bug"
      ],
      "link": "https://app.plane.so/acme/browse/WEB-42/",
      "name": "Fix the sign-up form on mobile",
      "priority": "high",
      "project_id": "2c9e1f7a-5b3d-4e6f-8a1b-9c0d2e3f4a5b",
      "start_date": "2026-10-28",
      "state": "In Progress",
      "state_group": "started",
      "target_date": "2026-11-04",
      "updated_at": "2026-10-28T09:30:00Z"
    }
  ]
}
```

### Search work items

Find work items whose title or identifier matches some words.

**Inputs**

- Words (`query`, text, required): Words from the title, or an identifier such as WEB-42.
- Project (`project`, text): Only look in this project. Leave blank for the whole workspace.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many
- `work_items` (list): The work items found

**Example output**

```json
{
  "count": 1,
  "work_items": [
    {
      "id": "8d0f6a4e-3b1c-4d2a-9e7f-1a2b3c4d5e6f",
      "identifier": "WEB-42",
      "link": "https://app.plane.so/acme/browse/WEB-42/",
      "name": "Fix the sign-up form on mobile",
      "project_id": "2c9e1f7a-5b3d-4e6f-8a1b-9c0d2e3f4a5b"
    }
  ]
}
```

### Update work item

Change a work item's title, description, state, priority, people, labels or dates.

**Inputs**

- Work item (`work_item`, text, required): The work item, such as WEB-42, or its link.
- Title (`name`, text): A new title. Leave blank to keep it.
- Description (`description`, text): What it's about, in plain text. Leave blank to keep it.
- State (`state`, text): Its state, such as Todo or Done. Leave blank to keep it.
- Priority (`priority`, text): How urgent it is. Leave blank to keep it. One of: `urgent`, `high`, `medium`, `low`, `none`.
- Assignees (`assignees`, list): Who works on it. Leave blank to keep it.
- Labels (`labels`, list): Its labels. Leave blank to keep it.
- Start date (`start_date`, date): When work starts. Leave blank to keep it.
- Due date (`target_date`, date): When it's due. Leave blank to keep it.

**Outputs**

- `assignees` (list): Who works on it
- `created_at` (text): When it was made (ISO 8601)
- `description` (text): What it's about, as plain text
- `id` (text): The work item's ID
- `identifier` (text): Its identifier, such as WEB-42
- `labels` (list): Its labels
- `link` (text): A link to it in Plane
- `name` (text): Its title
- `priority` (text): urgent, high, medium, low or none
- `project_id` (text): Its project's ID
- `start_date` (text): When work starts (YYYY-MM-DD)
- `state` (text): Its state, such as In Progress
- `state_group` (text): backlog, unstarted, started, completed or cancelled
- `target_date` (text): When it's due (YYYY-MM-DD)
- `updated_at` (text): When it last changed (ISO 8601)

**Example output**

```json
{
  "assignees": [
    "ada"
  ],
  "created_at": "2026-10-28T09:00:00Z",
  "description": "The submit button is hidden below the keyboard.",
  "id": "8d0f6a4e-3b1c-4d2a-9e7f-1a2b3c4d5e6f",
  "identifier": "WEB-42",
  "labels": [
    "Bug"
  ],
  "link": "https://app.plane.so/acme/browse/WEB-42/",
  "name": "Fix the sign-up form on mobile",
  "priority": "high",
  "project_id": "2c9e1f7a-5b3d-4e6f-8a1b-9c0d2e3f4a5b",
  "start_date": "2026-10-28",
  "state": "In Progress",
  "state_group": "started",
  "target_date": "2026-11-04",
  "updated_at": "2026-10-28T09:30:00Z"
}
```
