Plane
App · 15 actions
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.
Actions
| Action | What it does |
|---|---|
| Add comment | Comment on a work item. |
| Create label | Make a label in a project. |
| Create work item | Make a work item in a project, with its state, priority, people, labels and dates. |
| Delete label | Delete a label from a project. |
| Delete work item | Delete a work item. |
| Get current user | Who the connection acts as in Plane. |
| Get work item | Get a work item, such as WEB-42, with its description, state and people. |
| List comments | List a work item's comments, oldest first. |
| List labels | List a project's labels. |
| List members | List the people in the workspace. |
| List projects | List the workspace's projects you can see. |
| List states | List a project's states, such as Todo and Done, in board order. |
| List work items | List a project's work items, newest first. |
| Search work items | Find work items whose title or identifier matches some words. |
| Update work item | Change a work item's title, description, state, priority, people, labels or dates. |
Add comment
Comment on a work item.
Inputs
- Work item
work_itemtextRequired - The work item, such as WEB-42, or its link.
- Comment
commenttextRequired - What to say, in plain text.
Outputs
authortext- Who wrote it
commenttext- What it says, as plain text
created_attext- When (ISO 8601)
idtext- The comment's ID
work_itemtext- The work item, such as WEB-42
Example output
{
"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
projecttextRequired - The project.
- Name
nametextRequired - What to call it, such as Customer request.
- Colour
colortext - Its colour, such as #ff6900. Leave blank for Plane's default.
Outputs
colortext- Its colour
idtext- Its ID
nametext- Its name
Example output
{
"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
projecttextRequired - The project to make it in.
- Title
nametextRequired - The work item's title.
- Description
descriptiontext - What it's about, in plain text.
- State
statetext - Its state, such as Todo or Done. Leave blank for the project's default.
- Priority
prioritytext - How urgent it is.One of:
urgent,high,medium,low,none. - Assignees
assigneeslist - Who works on it.
- Labels
labelslist - Its labels.
- Start date
start_datedate - When work starts.
- Due date
target_datedate - When it's due.
Outputs
assigneeslist- Who works on it
created_attext- When it was made (ISO 8601)
descriptiontext- What it's about, as plain text
idtext- The work item's ID
identifiertext- Its identifier, such as WEB-42
labelslist- Its labels
linktext- A link to it in Plane
nametext- Its title
prioritytext- urgent, high, medium, low or none
project_idtext- Its project's ID
start_datetext- When work starts (YYYY-MM-DD)
statetext- Its state, such as In Progress
state_grouptext- backlog, unstarted, started, completed or cancelled
target_datetext- When it's due (YYYY-MM-DD)
updated_attext- When it last changed (ISO 8601)
Example output
{
"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
projecttextRequired - The project.
- Label
labeltextRequired - The label.
Outputs
deletedtrue/false- True once deleted
idtext- The label's ID
Example output
{
"deleted": true,
"id": "3c2b1a09-8f7e-4d6c-b5a4-938271605f4e"
}Delete work item
Delete a work item.
Inputs
- Work item
work_itemtextRequired - The work item, such as WEB-42, or its link.
Outputs
deletedtrue/false- True once deleted
identifiertext- The work item deleted
Example output
{
"deleted": true,
"identifier": "WEB-42"
}Get current user
Who the connection acts as in Plane.
Inputs
None.
Outputs
display_nametext- Their display name
emailtext- Their email address
idtext- Their ID
nametext- Their name
workspacetext- The workspace the connection works in
Example output
{
"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_itemtextRequired - The work item, such as WEB-42, or its link.
Outputs
assigneeslist- Who works on it
created_attext- When it was made (ISO 8601)
descriptiontext- What it's about, as plain text
idtext- The work item's ID
identifiertext- Its identifier, such as WEB-42
labelslist- Its labels
linktext- A link to it in Plane
nametext- Its title
prioritytext- urgent, high, medium, low or none
project_idtext- Its project's ID
start_datetext- When work starts (YYYY-MM-DD)
statetext- Its state, such as In Progress
state_grouptext- backlog, unstarted, started, completed or cancelled
target_datetext- When it's due (YYYY-MM-DD)
updated_attext- When it last changed (ISO 8601)
Example output
{
"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_itemtextRequired - The work item, such as WEB-42, or its link.
Outputs
commentslist- The comments
countnumber- How many
Example output
{
"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
projecttextRequired - The project.
Outputs
countnumber- How many
labelslist- The labels
Example output
{
"count": 1,
"labels": [
{
"color": "#ef4444",
"id": "3c2b1a09-8f7e-4d6c-b5a4-938271605f4e",
"name": "Bug"
}
]
}List members
List the people in the workspace.
Inputs
None.
Outputs
countnumber- How many
memberslist- The people
Example output
{
"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
countnumber- How many
projectslist- The projects
Example output
{
"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
projecttextRequired - The project.
Outputs
countnumber- How many
stateslist- The states
Example output
{
"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
projecttextRequired - The project.
- How many
limitnumber - The most to list. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many
work_itemslist- The work items
Example output
{
"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
querytextRequired - Words from the title, or an identifier such as WEB-42.
- Project
projecttext - Only look in this project. Leave blank for the whole workspace.
- How many
limitnumber - The most to list. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many
work_itemslist- The work items found
Example output
{
"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_itemtextRequired - The work item, such as WEB-42, or its link.
- Title
nametext - A new title. Leave blank to keep it.
- Description
descriptiontext - What it's about, in plain text. Leave blank to keep it.
- State
statetext - Its state, such as Todo or Done. Leave blank to keep it.
- Priority
prioritytext - How urgent it is. Leave blank to keep it.One of:
urgent,high,medium,low,none. - Assignees
assigneeslist - Who works on it. Leave blank to keep it.
- Labels
labelslist - Its labels. Leave blank to keep it.
- Start date
start_datedate - When work starts. Leave blank to keep it.
- Due date
target_datedate - When it's due. Leave blank to keep it.
Outputs
assigneeslist- Who works on it
created_attext- When it was made (ISO 8601)
descriptiontext- What it's about, as plain text
idtext- The work item's ID
identifiertext- Its identifier, such as WEB-42
labelslist- Its labels
linktext- A link to it in Plane
nametext- Its title
prioritytext- urgent, high, medium, low or none
project_idtext- Its project's ID
start_datetext- When work starts (YYYY-MM-DD)
statetext- Its state, such as In Progress
state_grouptext- backlog, unstarted, started, completed or cancelled
target_datetext- When it's due (YYYY-MM-DD)
updated_attext- When it last changed (ISO 8601)
Example output
{
"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"
}