# PLANKA

> Keep your PLANKA boards moving without opening them: turn emails, form responses and tickets into cards, move cards between lists, add labels, members, checklists, comments and files, and send a summary of a board. Start a workflow when a card is created or moved, someone comments, a task is ticked off or a card is due.

App · 37 actions. Web page: https://docs.lodol.com/docs/integrations/planka

## Actions

### Add comment

Comment on a card, as the person the connection acts as.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Comment (`text`, text, required): What the comment says. PLANKA shows Markdown formatted.

**Outputs**

- `card_id` (text): The ID of the card it's on
- `created_at` (text): When it was written
- `id` (text): The comment's ID, which 'Delete comment' takes
- `text` (text): What it says
- `user_id` (text): The ID of the person who wrote it
- `user_name` (text): Their name

**Example output**

```json
{
  "card_id": "1909958737779491858",
  "created_at": "2026-11-03T14:05:00.000Z",
  "id": "1909958739314607138",
  "text": "Needs a shorter headline.",
  "user_id": "1909958735514567684",
  "user_name": "Riley Chen"
}
```

### Add label to card

Put one of the board's labels on a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Label (`label`, text, required): One of the labels of the card's board: pick one, or give its ID or its name, such as Urgent.

**Outputs**

- `added` (true/false): Whether the label was added: false when the card already had it
- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_id` (text): The label's ID
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "added": true,
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_id": "1909958736697361423",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "name": "Write homepage copy",
  "position": 65536,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Add member to card

Add a member of the board to a card, such as whoever is on call.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Person (`user`, text, required): A member of the card's board: pick one, or give their ID, username, email or name.

**Outputs**

- `added` (true/false): Whether they were added: false when they were already on the card
- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed
- `user_id` (text): The person's ID

**Example output**

```json
{
  "added": true,
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "name": "Write homepage copy",
  "position": 65536,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z",
  "user_id": "1909958735514567684"
}
```

### Add task

Add a task to a card's task list.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Task (`name`, text, required): What the task says.
- Task list (`task_list`, text): The task list to add it to (its name or ID). Leave blank for the card's first one; a card with none gets one called Tasks.

**Outputs**

- `assignee_id` (text): The ID of the person it's given to, blank for nobody
- `card_id` (text): The ID of the card it's on
- `completed` (true/false): Whether it's ticked off
- `id` (text): The task's ID, which other PLANKA steps take
- `name` (text): What the task says
- `task_list_id` (text): The ID of the task list it's in
- `task_list_name` (text): The name of the task list it was added to

**Example output**

```json
{
  "assignee_id": "",
  "card_id": "1909958737779491858",
  "completed": false,
  "id": "1909958740077970472",
  "name": "Review",
  "task_list_id": "1909958739624985637",
  "task_list_name": "Checklist"
}
```

### Add task list

Add a task list (a checklist) to a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Name (`name`, text, required): What to call the task list, such as Checklist.

**Outputs**

- `card_id` (text): The ID of the card it's on
- `id` (text): The task list's ID, which other PLANKA steps take
- `name` (text): The task list's name
- `tasks` (list): Its tasks, in order

**Example output**

```json
{
  "card_id": "1909958737779491858",
  "id": "1909958739624985637",
  "name": "Checklist",
  "tasks": []
}
```

### Attach file to card

Attach a file, such as an email's attachment or a generated report, to a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- File (`file`, text, required): The file: upload one, pick one from an earlier step, or give a public https link to download.
- Name (`name`, text): What to call the attachment. Leave blank for the file's own name.

**Outputs**

- `card_id` (text): The ID of the card it's on
- `created_at` (text): When it was added
- `id` (text): The attachment's ID, which other PLANKA steps take
- `name` (text): Its name
- `size` (number): A file's size in bytes, 0 for a link
- `type` (text): file or link
- `url` (text): The link, or where the file downloads for someone signed in

**Example output**

```json
{
  "card_id": "1909958737779491858",
  "created_at": "2026-11-03T10:00:00.000Z",
  "id": "1909959969722074162",
  "name": "brief.pdf",
  "size": 48213,
  "type": "file",
  "url": "https://planka.example.com/attachments/1909959969722074162/download/brief.pdf"
}
```

### Attach link to card

Attach a link, such as the document or ticket a card is about, to a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Link (`url`, text, required): The link, such as https://example.com/brief.
- Name (`name`, text): What to call the link. Leave blank for the site's address.

**Outputs**

- `card_id` (text): The ID of the card it's on
- `created_at` (text): When it was added
- `id` (text): The attachment's ID, which other PLANKA steps take
- `name` (text): Its name
- `size` (number): A file's size in bytes, 0 for a link
- `type` (text): file or link
- `url` (text): The link, or where the file downloads for someone signed in

**Example output**

```json
{
  "card_id": "1909958737779491858",
  "created_at": "2026-11-03T10:00:00.000Z",
  "id": "1909959969722074162",
  "name": "Brief",
  "size": 0,
  "type": "link",
  "url": "https://example.com/brief"
}
```

### Create board

Add a board to a project, after its other boards. The person the connection acts as becomes its first member.

**Inputs**

- Project (`project`, text, required): The project: pick one, or give its ID from another PLANKA step, its link or its name.
- Name (`name`, text, required): What to call the board.

**Outputs**

- `cards` (list): The board's cards, list by list (not the archive or trash)
- `cards_total` (number): How many cards that is
- `created_at` (text): When it was created
- `id` (text): The board's ID, which other PLANKA steps take
- `labels` (list): The board's labels
- `link` (text): Where the board opens in PLANKA
- `lists` (list): The board's lists, left to right
- `members` (list): The people on the board
- `name` (text): The board's name
- `position` (number): Where it sits among the project's boards
- `project_id` (text): The ID of the project it belongs to
- `project_name` (text): That project's name

**Example output**

```json
{
  "cards": [],
  "cards_total": 0,
  "created_at": "2026-11-02T09:16:00.000Z",
  "id": "1909958735917220871",
  "labels": [],
  "link": "https://planka.example.com/boards/1909958735917220871",
  "lists": [],
  "members": [
    {
      "board_role": "editor",
      "deactivated": false,
      "email": "riley@example.com",
      "id": "1909958735514567684",
      "name": "Riley Chen",
      "role": "boardUser",
      "username": "riley"
    }
  ],
  "name": "Launch plan",
  "position": 65536,
  "project_id": "1909958735665562629",
  "project_name": "Website relaunch"
}
```

### Create card

Add a card to a list, such as one for each new form response or email, with a description and a due date.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.
- List (`list`, text, required): The list on that board: pick one, or give its ID or its name, such as Doing.
- Title (`name`, text, required): The card's title.
- Description (`description`, text): The card's description. PLANKA shows Markdown formatted.
- Due date (`due_date`, date and time): When the card is due. Leave blank for no due date.
- Position (`position`, text): Whether it goes last or first. Defaults to last. One of: `bottom` (Last), `top` (First). Default: `bottom`.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_ids": [],
  "labels": [],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [],
  "members": [],
  "name": "Write homepage copy",
  "position": 65536,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Create label

Add a label, such as Urgent, to a board.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.
- Name (`name`, text, required): What the label says.
- Color (`color`, text): The label's colour. Defaults to lagoon blue. One of: `berry-red` (Berry red), `pumpkin-orange` (Pumpkin orange), `light-orange` (Light orange), `egg-yellow` (Egg yellow), `sunny-grass` (Sunny grass), `fresh-salad` (Fresh salad), `bright-moss` (Bright moss), `tank-green` (Tank green), `lagoon-blue` (Lagoon blue), `morning-sky` (Morning sky), and 32 more. Default: `lagoon-blue`.

**Outputs**

- `board_id` (text): The ID of the board it belongs to
- `color` (text): Its colour, as PLANKA names it, such as berry-red
- `id` (text): The label's ID, which other PLANKA steps take
- `name` (text): What the label says

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "color": "berry-red",
  "id": "1909958736697361423",
  "name": "Urgent"
}
```

### Create list

Add a list, such as To do or Done, to a board.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.
- Name (`name`, text, required): What to call the list.
- Type (`list_type`, text): Active for work in progress, or closed for a list whose cards count as done. Defaults to active. One of: `active`, `closed`. Default: `active`.
- Position (`position`, text): Whether it goes last or first. Defaults to last. One of: `bottom` (Last), `top` (First). Default: `bottom`.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `cards_total` (number): How many cards are in it
- `id` (text): The list's ID, which other PLANKA steps take
- `name` (text): The list's name
- `position` (number): Where it sits on the board
- `type` (text): active, or closed for a list whose cards count as done

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "cards_total": 0,
  "id": "1909958736303096844",
  "name": "To do",
  "position": 65536,
  "type": "active"
}
```

### Create project

Start a project, such as one for each new client. The person the connection acts as becomes its manager.

**Inputs**

- Name (`name`, text, required): What to call the project.
- Description (`description`, text): What the project is for.
- Visibility (`visibility`, text): Private is seen by its managers and the members of its boards; shared is also seen by every administrator. Defaults to private. One of: `private`, `shared`. Default: `private`.

**Outputs**

- `boards` (list): The project's boards
- `boards_total` (number): How many of its boards the connection can see
- `created_at` (text): When it was created
- `description` (text): Its description
- `hidden` (true/false): Whether the project is hidden from the home page
- `id` (text): The project's ID, which other PLANKA steps take
- `link` (text): Where the project opens in PLANKA
- `name` (text): The project's name

**Example output**

```json
{
  "boards": [],
  "boards_total": 0,
  "created_at": "2026-11-02T09:15:00.000Z",
  "description": "Everything for the spring launch",
  "hidden": false,
  "id": "1909958735665562629",
  "link": "https://planka.example.com/projects/1909958735665562629",
  "name": "Website relaunch"
}
```

### Delete attachment

Delete a file or link from its card.

**Inputs**

- Attachment (`attachment`, text, required): The attachment's ID, from 'List attachments', 'Get card' or an attach step.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909959969722074162",
  "name": "brief.pdf"
}
```

### Delete board

Delete a board for good, with its lists, cards, comments and attachments.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909958735917220871",
  "name": "Launch plan"
}
```

### Delete card

Delete a card for good, with its comments, tasks and attachments.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909958737779491858",
  "name": "Write homepage copy"
}
```

### Delete comment

Delete a comment. The person the connection acts as must have written it, or manage the project.

**Inputs**

- Comment (`comment`, text, required): The comment's ID, from 'Add comment', 'List comments' or a trigger.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909958739314607138",
  "name": ""
}
```

### Delete list

Delete a list from a board. PLANKA moves its cards to the board's trash.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.
- List (`list`, text, required): The list on that board: pick one, or give its ID or its name, such as Doing.

**Outputs**

- `cards_moved_to_trash` (number): How many cards PLANKA moved to the board's trash
- `deleted` (true/false): True once the list is deleted
- `id` (text): The deleted list's ID
- `name` (text): Its name

**Example output**

```json
{
  "cards_moved_to_trash": 2,
  "deleted": true,
  "id": "1909958736303096844",
  "name": "To do"
}
```

### Delete project

Delete a project. PLANKA deletes only a project with no boards, so delete its boards first.

**Inputs**

- Project (`project`, text, required): The project: pick one, or give its ID from another PLANKA step, its link or its name.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909958735665562629",
  "name": "Website relaunch"
}
```

### Delete task

Delete a task from its task list.

**Inputs**

- Task (`task`, text, required): The task: its ID from another PLANKA step, or its name if you also give the card it's on.
- Card (`card`, text): The card the task is on (its ID or link). Only needed when the task is given by name.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909958740077970472",
  "name": "Review"
}
```

### Delete task list

Delete a task list from a card, with its tasks.

**Inputs**

- Task list (`task_list`, text, required): The task list: its ID from another PLANKA step, or its name if you also give the card it's on.
- Card (`card`, text): The card the task list is on (its ID or link). Only needed when the task list is given by name.

**Outputs**

- `deleted` (true/false): True once it's deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name, blank for a comment

**Example output**

```json
{
  "deleted": true,
  "id": "1909958739624985637",
  "name": "Checklist"
}
```

### Duplicate card

Copy a card, such as a template card, with its description, labels, members, task lists and attachments, to the end of its list.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Title (`name`, text): The copy's title. Leave blank for the original's.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `copied_from_id` (text): The ID of the card it was copied from
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "copied_from_id": "1909958737779491858",
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909959967624922157",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909959967624922157",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "name": "Write homepage copy (copy)",
  "position": 65536,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Get board

Get a board with its lists, labels, members and cards, such as for a weekly summary of what's in each list.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.

**Outputs**

- `cards` (list): The board's cards, list by list (not the archive or trash)
- `cards_total` (number): How many cards that is
- `created_at` (text): When it was created
- `id` (text): The board's ID, which other PLANKA steps take
- `labels` (list): The board's labels
- `link` (text): Where the board opens in PLANKA
- `lists` (list): The board's lists, left to right
- `members` (list): The people on the board
- `name` (text): The board's name
- `position` (number): Where it sits among the project's boards
- `project_id` (text): The ID of the project it belongs to
- `project_name` (text): That project's name

**Example output**

```json
{
  "cards": [
    {
      "board_id": "1909958735917220871",
      "board_name": "Launch plan",
      "closed": false,
      "comments_total": 2,
      "created_at": "2026-11-02T09:20:00.000Z",
      "description": "Headline, three sections and a call to action.",
      "due_completed": false,
      "due_date": "2026-11-19T17:00:00.000Z",
      "id": "1909958737779491858",
      "label_ids": [
        "1909958736697361423"
      ],
      "labels": [
        "Urgent"
      ],
      "link": "https://planka.example.com/cards/1909958737779491858",
      "list_id": "1909958736303096844",
      "list_name": "To do",
      "member_ids": [
        "1909958735514567684"
      ],
      "members": [
        "Riley Chen"
      ],
      "name": "Write homepage copy",
      "position": 65536,
      "tasks_completed": 1,
      "tasks_total": 3,
      "updated_at": "2026-11-03T14:05:00.000Z"
    }
  ],
  "cards_total": 1,
  "created_at": "2026-11-02T09:16:00.000Z",
  "id": "1909958735917220871",
  "labels": [
    {
      "board_id": "1909958735917220871",
      "color": "berry-red",
      "id": "1909958736697361423",
      "name": "Urgent"
    }
  ],
  "link": "https://planka.example.com/boards/1909958735917220871",
  "lists": [
    {
      "board_id": "1909958735917220871",
      "cards_total": 2,
      "id": "1909958736303096844",
      "name": "To do",
      "position": 65536,
      "type": "active"
    }
  ],
  "members": [
    {
      "board_role": "editor",
      "deactivated": false,
      "email": "riley@example.com",
      "id": "1909958735514567684",
      "name": "Riley Chen",
      "role": "boardUser",
      "username": "riley"
    }
  ],
  "name": "Launch plan",
  "position": 65536,
  "project_id": "1909958735665562629",
  "project_name": "Website relaunch"
}
```

### Get card

Get a card with its list, labels, members, due date, task lists and attachments.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.

**Outputs**

- `attachments` (list): Its files and links
- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `task_lists` (list): Its task lists, each with its tasks
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "attachments": [
    {
      "card_id": "1909958737779491858",
      "created_at": "2026-11-03T10:00:00.000Z",
      "id": "1909959969722074162",
      "name": "brief.pdf",
      "size": 48213,
      "type": "file",
      "url": "https://planka.example.com/attachments/1909959969722074162/download/brief.pdf"
    }
  ],
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "name": "Write homepage copy",
  "position": 65536,
  "task_lists": [
    {
      "id": "1909958739624985637",
      "name": "Checklist",
      "tasks": [
        {
          "assignee_id": "",
          "completed": true,
          "id": "1909958740077970472",
          "name": "Review",
          "task_list_id": "1909958739624985637"
        }
      ]
    }
  ],
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Get project

Get a project with its boards.

**Inputs**

- Project (`project`, text, required): The project: pick one, or give its ID from another PLANKA step, its link or its name.

**Outputs**

- `boards` (list): The project's boards
- `boards_total` (number): How many of its boards the connection can see
- `created_at` (text): When it was created
- `description` (text): Its description
- `hidden` (true/false): Whether the project is hidden from the home page
- `id` (text): The project's ID, which other PLANKA steps take
- `link` (text): Where the project opens in PLANKA
- `name` (text): The project's name

**Example output**

```json
{
  "boards": [
    {
      "created_at": "2026-11-02T09:16:00.000Z",
      "id": "1909958735917220871",
      "link": "https://planka.example.com/boards/1909958735917220871",
      "name": "Launch plan",
      "position": 65536,
      "project_id": "1909958735665562629",
      "project_name": "Website relaunch"
    }
  ],
  "boards_total": 1,
  "created_at": "2026-11-02T09:15:00.000Z",
  "description": "Everything for the spring launch",
  "hidden": false,
  "id": "1909958735665562629",
  "link": "https://planka.example.com/projects/1909958735665562629",
  "name": "Website relaunch"
}
```

### List attachments

List the files and links attached to a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.

**Outputs**

- `attachments` (list): The card's files and links
- `count` (number): How many there are

**Example output**

```json
{
  "attachments": [
    {
      "card_id": "1909958737779491858",
      "created_at": "2026-11-03T10:00:00.000Z",
      "id": "1909959969722074162",
      "name": "brief.pdf",
      "size": 48213,
      "type": "file",
      "url": "https://planka.example.com/attachments/1909959969722074162/download/brief.pdf"
    }
  ],
  "count": 1
}
```

### List boards

List the boards the connection can see, in one project or in all of them.

**Inputs**

- Project (`project`, text): Only this project's boards. Leave blank for every project.

**Outputs**

- `boards` (list): The boards
- `count` (number): How many there are

**Example output**

```json
{
  "boards": [
    {
      "created_at": "2026-11-02T09:16:00.000Z",
      "id": "1909958735917220871",
      "link": "https://planka.example.com/boards/1909958735917220871",
      "name": "Launch plan",
      "position": 65536,
      "project_id": "1909958735665562629",
      "project_name": "Website relaunch"
    }
  ],
  "count": 1
}
```

### List cards

List a board's cards in the board's order: all of them, or those in one list, with one label, given to one person, or with certain words.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.
- List (`list`, text): Only cards in this list, such as Doing.
- Label (`label`, text): Only cards with this label.
- Member (`member`, text): Only cards this person is on.
- Search (`search`, text): Only cards whose title or description has all of these words.
- Limit (`limit`, number): The most cards to return, from 1 to 1000. Leave blank for 100. From 1 to 1000.

**Outputs**

- `cards` (list): The cards, in the board's order
- `count` (number): How many cards are returned
- `has_more` (true/false): Whether more matched than the limit returned
- `total` (number): How many cards matched

**Example output**

```json
{
  "cards": [
    {
      "board_id": "1909958735917220871",
      "board_name": "Launch plan",
      "closed": false,
      "comments_total": 2,
      "created_at": "2026-11-02T09:20:00.000Z",
      "description": "Headline, three sections and a call to action.",
      "due_completed": false,
      "due_date": "2026-11-19T17:00:00.000Z",
      "id": "1909958737779491858",
      "label_ids": [
        "1909958736697361423"
      ],
      "labels": [
        "Urgent"
      ],
      "link": "https://planka.example.com/cards/1909958737779491858",
      "list_id": "1909958736303096844",
      "list_name": "To do",
      "member_ids": [
        "1909958735514567684"
      ],
      "members": [
        "Riley Chen"
      ],
      "name": "Write homepage copy",
      "position": 65536,
      "tasks_completed": 1,
      "tasks_total": 3,
      "updated_at": "2026-11-03T14:05:00.000Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "total": 1
}
```

### List comments

List a card's comments, newest first.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Limit (`limit`, number): The most comments to return, from 1 to 1000. Leave blank for 100. From 1 to 1000.

**Outputs**

- `comments` (list): The comments, newest first
- `count` (number): How many are returned
- `has_more` (true/false): Whether the card has more than the limit returned

**Example output**

```json
{
  "comments": [
    {
      "card_id": "1909958737779491858",
      "created_at": "2026-11-03T14:05:00.000Z",
      "id": "1909958739314607138",
      "text": "Needs a shorter headline.",
      "user_id": "1909958735514567684",
      "user_name": "Riley Chen"
    }
  ],
  "count": 1,
  "has_more": false
}
```

### List labels

List a board's labels.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.

**Outputs**

- `count` (number): How many there are
- `labels` (list): The board's labels

**Example output**

```json
{
  "count": 1,
  "labels": [
    {
      "board_id": "1909958735917220871",
      "color": "berry-red",
      "id": "1909958736697361423",
      "name": "Urgent"
    }
  ]
}
```

### List people

List the people in PLANKA, to find who to add to a card. A connection that isn't an administrator or project owner gets the people in its own projects.

**Inputs**: None.

**Outputs**

- `count` (number): How many there are
- `users` (list): The people

**Example output**

```json
{
  "count": 1,
  "users": [
    {
      "deactivated": false,
      "email": "riley@example.com",
      "id": "1909958735514567684",
      "name": "Riley Chen",
      "role": "boardUser",
      "username": "riley"
    }
  ]
}
```

### List projects

List the projects the connection can see, with how many boards each has.

**Inputs**: None.

**Outputs**

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

**Example output**

```json
{
  "count": 1,
  "projects": [
    {
      "boards_total": 1,
      "created_at": "2026-11-02T09:15:00.000Z",
      "description": "Everything for the spring launch",
      "hidden": false,
      "id": "1909958735665562629",
      "link": "https://planka.example.com/projects/1909958735665562629",
      "name": "Website relaunch"
    }
  ]
}
```

### Move card

Move a card to another list, such as Done, on its own board or another.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Board (`board`, text, required): The board to move it to (the card's own board, or another): pick one, or give its ID from another PLANKA step, its link or its name.
- List (`list`, text, required): The list to move it to: pick one, or give its ID or its name, such as Done.
- Position (`position`, text): Whether it goes last or first. Defaults to last. One of: `bottom` (Last), `top` (First). Default: `bottom`.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `moved_from_list_id` (text): The ID of the list the card was in before
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736428925965",
  "list_name": "Doing",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "moved_from_list_id": "1909958736303096844",
  "name": "Write homepage copy",
  "position": 65536,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Remove label from card

Take a label off a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Label (`label`, text, required): One of the labels of the card's board: pick one, or give its ID or its name, such as Urgent.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_id` (text): The label's ID
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `removed` (true/false): Whether the label was taken off: false when the card didn't have it
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_id": "1909958736697361423",
  "label_ids": [],
  "labels": [],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "name": "Write homepage copy",
  "position": 65536,
  "removed": true,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Remove member from card

Take a person off a card.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Person (`user`, text, required): A member of the card's board: pick one, or give their ID, username, email or name.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `removed` (true/false): Whether they were taken off: false when they weren't on the card
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed
- `user_id` (text): The person's ID

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [],
  "members": [],
  "name": "Write homepage copy",
  "position": 65536,
  "removed": true,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z",
  "user_id": "1909958735514567684"
}
```

### Update card

Change a card's title, description or due date, or tick its due date as done. Fields left blank stay as they are.

**Inputs**

- Card (`card`, text, required): The card: its ID from another PLANKA step or a trigger, or its link in PLANKA.
- Title (`name`, text): A new title.
- Description (`description`, text): A new description.
- Due date (`due_date`, date and time): A new due date.
- Remove due date (`remove_due_date`, true/false): Turn on to take the due date off the card. Default: `false`.
- Due date done (`due_completed`, text): Whether the due date is ticked as done. One of: `keep` (Leave as it is), `yes`, `no`. Default: `keep`.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `board_name` (text): That board's name
- `closed` (true/false): Whether it's in a closed list, so counts as done
- `comments_total` (number): How many comments it has
- `created_at` (text): When it was created
- `description` (text): Its description
- `due_completed` (true/false): Whether its due date is ticked as done
- `due_date` (text): When it's due, blank when it has no due date
- `id` (text): The card's ID, which other PLANKA steps take
- `label_ids` (list): The IDs of its labels
- `labels` (list): The names of its labels
- `link` (text): Where the card opens in PLANKA
- `list_id` (text): The ID of the list it's in
- `list_name` (text): That list's name, such as Doing
- `member_ids` (list): The IDs of the people on it
- `members` (list): The names of the people on it
- `name` (text): The card's title
- `position` (number): Where it sits in its list
- `tasks_completed` (number): How many of them are ticked off
- `tasks_total` (number): How many tasks it has
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "board_name": "Launch plan",
  "closed": false,
  "comments_total": 2,
  "created_at": "2026-11-02T09:20:00.000Z",
  "description": "Headline, three sections and a call to action.",
  "due_completed": false,
  "due_date": "2026-11-19T17:00:00.000Z",
  "id": "1909958737779491858",
  "label_ids": [
    "1909958736697361423"
  ],
  "labels": [
    "Urgent"
  ],
  "link": "https://planka.example.com/cards/1909958737779491858",
  "list_id": "1909958736303096844",
  "list_name": "To do",
  "member_ids": [
    "1909958735514567684"
  ],
  "members": [
    "Riley Chen"
  ],
  "name": "Write homepage copy",
  "position": 65536,
  "tasks_completed": 1,
  "tasks_total": 3,
  "updated_at": "2026-11-03T14:05:00.000Z"
}
```

### Update list

Rename a list, move it first or last on its board, or change whether its cards count as done.

**Inputs**

- Board (`board`, text, required): The board: pick one, or give its ID from another PLANKA step, its link or its name, such as Launch plan.
- List (`list`, text, required): The list on that board: pick one, or give its ID or its name, such as Doing.
- Name (`name`, text): A new name. Leave blank to keep it.
- Position (`position`, text): Move the list first or last on the board. One of: `keep` (Leave where it is), `top` (First), `bottom` (Last). Default: `keep`.
- Type (`list_type`, text): Active, or closed for a list whose cards count as done. One of: `keep` (Leave as it is), `active`, `closed`. Default: `keep`.

**Outputs**

- `board_id` (text): The ID of the board it's on
- `cards_total` (number): How many cards are in it
- `id` (text): The list's ID, which other PLANKA steps take
- `name` (text): The list's name
- `position` (number): Where it sits on the board
- `type` (text): active, or closed for a list whose cards count as done

**Example output**

```json
{
  "board_id": "1909958735917220871",
  "cards_total": 2,
  "id": "1909958736303096844",
  "name": "To do",
  "position": 65536,
  "type": "active"
}
```

### Update task

Tick a task off or untick it, rename it, or give it to someone.

**Inputs**

- Task (`task`, text, required): The task: its ID from another PLANKA step, or its name if you also give the card it's on.
- Card (`card`, text): The card the task is on (its ID or link). Only needed when the task is given by name.
- Completed (`completed`, text): Whether the task is ticked off. One of: `keep` (Leave as it is), `yes`, `no`. Default: `keep`.
- Name (`name`, text): A new name for the task.
- Assignee (`assignee`, text): Who the task is given to: a member of the board.

**Outputs**

- `assignee_id` (text): The ID of the person it's given to, blank for nobody
- `completed` (true/false): Whether it's ticked off
- `id` (text): The task's ID, which other PLANKA steps take
- `name` (text): What the task says
- `task_list_id` (text): The ID of the task list it's in

**Example output**

```json
{
  "assignee_id": "",
  "completed": true,
  "id": "1909958740077970472",
  "name": "Review",
  "task_list_id": "1909958739624985637"
}
```
