# Canny

> Collect and manage customer feedback in Canny. Read boards, posts, comments, votes, users and tags, create and update posts, move them through statuses, comment and vote as your users, and write, publish or schedule changelog entries. Triggers start a workflow when a new post arrives or a post changes status.

App · 31 actions. Web page: https://docs.lodol.com/docs/integrations/canny

## Actions

### Add tag to post

Tag a post. The tag must be one of its board's tags.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Tag (`tag_id`, text, required): The tag. Pick one, or give its id from an earlier step.

**Outputs**

- `post` (object): The updated post

**Example output**

```json
{
  "post": {
    "author": {
      "alias": "jo",
      "avatarURL": "",
      "companies": [],
      "created": "2026-01-05T10:00:00.000Z",
      "customFields": {},
      "email": "jo@example.com",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isAdmin": false,
      "lastActivity": "2026-02-01T09:00:00.000Z",
      "name": "Jo Bloggs",
      "url": "https://acme.canny.io/admin/users/jo",
      "userID": "usr_123"
    },
    "board": {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    },
    "by": null,
    "category": {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "Integrations",
      "parentID": "",
      "postCount": 4,
      "url": "https://acme.canny.io/feature-requests?category=integrations"
    },
    "commentCount": 2,
    "created": "2026-01-10T10:00:00.000Z",
    "customFields": {},
    "details": "Please add a dark theme.",
    "eta": "03/2027",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "imageURLs": [],
    "owner": null,
    "score": 14,
    "status": "planned",
    "statusChangedAt": "2026-02-01T10:00:00.000Z",
    "tags": [
      {
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "created": "2026-01-02T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "name": "enterprise",
        "postCount": 3,
        "url": "https://acme.canny.io/feature-requests?tags=enterprise"
      }
    ],
    "title": "Dark mode",
    "url": "https://acme.canny.io/feature-requests/p/dark-mode"
  }
}
```

### Add vote

Add a user's vote to a post.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Voter (`voter_id`, text, required): Who is voting. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Voted at (`created_at`, date and time): Back-date the vote to this date and time.

**Outputs**

- `post_id` (text): The post's id
- `voted` (true/false): True once Canny confirms it
- `voter_id` (text): The voter's id

**Example output**

```json
{
  "post_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "voted": true,
  "voter_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Change post category

Put a post in a category, or take it out of its category.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Category (`category_id`, text): The category. Pick one, or give its id from an earlier step.
- Remove category (`remove_category`, true/false): Take the post out of its category instead of choosing one. Default: `false`.

**Outputs**

- `post` (object): The updated post

**Example output**

```json
{
  "post": {
    "author": {
      "alias": "jo",
      "avatarURL": "",
      "companies": [],
      "created": "2026-01-05T10:00:00.000Z",
      "customFields": {},
      "email": "jo@example.com",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isAdmin": false,
      "lastActivity": "2026-02-01T09:00:00.000Z",
      "name": "Jo Bloggs",
      "url": "https://acme.canny.io/admin/users/jo",
      "userID": "usr_123"
    },
    "board": {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    },
    "by": null,
    "category": {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "Integrations",
      "parentID": "",
      "postCount": 4,
      "url": "https://acme.canny.io/feature-requests?category=integrations"
    },
    "commentCount": 2,
    "created": "2026-01-10T10:00:00.000Z",
    "customFields": {},
    "details": "Please add a dark theme.",
    "eta": "03/2027",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "imageURLs": [],
    "owner": null,
    "score": 14,
    "status": "planned",
    "statusChangedAt": "2026-02-01T10:00:00.000Z",
    "tags": [
      {
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "created": "2026-01-02T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "name": "enterprise",
        "postCount": 3,
        "url": "https://acme.canny.io/feature-requests?tags=enterprise"
      }
    ],
    "title": "Dark mode",
    "url": "https://acme.canny.io/feature-requests/p/dark-mode"
  }
}
```

### Change post status

Move a post to a new status, optionally telling the people who voted and leaving a comment.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Changed by (`changer_id`, text, required): The admin changing it. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Status (`status`, text, required): The post's new status. One of: `open`, `under review`, `planned`, `in progress`, `complete`, `closed`.
- Tell voters (`should_notify_voters`, true/false): Email the people who voted that the status changed. Default: `false`.
- Comment (`comment`, text): A comment to show with the change, up to 2,500 characters.

**Outputs**

- `post` (object): The updated post

**Example output**

```json
{
  "post": {
    "author": {
      "alias": "jo",
      "avatarURL": "",
      "companies": [],
      "created": "2026-01-05T10:00:00.000Z",
      "customFields": {},
      "email": "jo@example.com",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isAdmin": false,
      "lastActivity": "2026-02-01T09:00:00.000Z",
      "name": "Jo Bloggs",
      "url": "https://acme.canny.io/admin/users/jo",
      "userID": "usr_123"
    },
    "board": {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    },
    "by": null,
    "category": {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "Integrations",
      "parentID": "",
      "postCount": 4,
      "url": "https://acme.canny.io/feature-requests?category=integrations"
    },
    "commentCount": 2,
    "created": "2026-01-10T10:00:00.000Z",
    "customFields": {},
    "details": "Please add a dark theme.",
    "eta": "03/2027",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "imageURLs": [],
    "owner": null,
    "score": 14,
    "status": "planned",
    "statusChangedAt": "2026-02-01T10:00:00.000Z",
    "tags": [
      {
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "created": "2026-01-02T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "name": "enterprise",
        "postCount": 3,
        "url": "https://acme.canny.io/feature-requests?tags=enterprise"
      }
    ],
    "title": "Dark mode",
    "url": "https://acme.canny.io/feature-requests/p/dark-mode"
  }
}
```

### Create category

Add a category to a board, optionally under another category.

**Inputs**

- Board (`board_id`, text, required): The board. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): The category's name, 1 to 30 characters.
- Parent category (`parent_id`, text): The category. Pick one, or give its id from an earlier step.
- Subscribe admins (`subscribe_admins`, true/false): Subscribe the company's admins to new posts in it. Default: `false`.

**Outputs**

- `category_id` (text): The new category's id

**Example output**

```json
{
  "category_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Create changelog entry

Write a changelog entry. It is a draft unless you publish it now or schedule it.

**Inputs**

- Title (`title`, text, required): The entry's title, up to 400 characters.
- Details (`details`, text, required): The entry's text, in Markdown.
- Type (`type`, text): What kind of change it is. One of: `new`, `improved`, `fixed`.
- Publish now (`published`, true/false): Publish the entry straight away. Default: `false`.
- Published on (`published_on`, date and time): A date and time in the past to show as the publish time.
- Schedule for (`scheduled_for`, date and time): A date and time in the future to publish the entry.
- Email subscribers (`notify`, true/false): Tell the entry's subscribers when it is published. Default: `false`.
- Label IDs (`label_ids`, list): The ids of the changelog labels, from an earlier entry's labels.
- Linked post IDs (`post_ids`, list): The ids of posts this entry is about; their voters can be told when it is published.

**Outputs**

- `entry_id` (text): The new entry's id

**Example output**

```json
{
  "entry_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Create comment

Comment on a post, written as one of the company's users.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Author (`author_id`, text, required): Who is commenting. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Comment (`value`, text, required): The comment's text, under 2,500 characters.
- Internal (`internal`, true/false): Show the comment to the company's team only. Default: `false`.
- Reply to (`parent_id`, text): The id of the comment this replies to.
- Tell voters (`should_notify_voters`, true/false): Email the people who voted on the post. Default: `false`.
- Created at (`created_at`, date and time): Back-date the comment to this date and time.

**Outputs**

- `comment_id` (text): The new comment's id

**Example output**

```json
{
  "comment_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Create or update user

Create a user, or update the one with the same email or id. Returns the user's Canny id, which posts, comments and votes need.

**Inputs**

- Name (`name`, text, required): The user's name, up to 50 characters.
- Email (`email`, text): The user's email address. Give this, 'Your user ID' or 'Canny ID'.
- Your user ID (`external_id`, text): The id your own app uses for the user.
- Canny ID (`canny_id`, text): The user's Canny id, to update them.
- Avatar URL (`avatar_url`, text): A link to the user's picture.
- Alias (`alias`, text): A short name or handle.
- Signed up at (`created`, date and time): When the user signed up to your product.
- Custom fields (`custom_fields`, object): Extra facts about the user, as {"Plan": "Pro"}.

**Outputs**

- `id` (text): The user's Canny id

**Example output**

```json
{
  "id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Create post

Create a post on a board, written as one of the company's users.

**Inputs**

- Board (`board_id`, text, required): The board. Pick one, or give its id from an earlier step.
- Author (`author_id`, text, required): Who is posting. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Title (`title`, text, required): The post's title, up to 400 characters.
- Details (`details`, text, required): The post's text, up to 10,000 characters.
- Category (`category_id`, text): The category. Pick one, or give its id from an earlier step.
- Owner (`owner_id`, text): The admin responsible for it. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- ETA (`eta`, date): When the work should be done. Canny keeps the month and year.
- Show ETA to everyone (`eta_public`, true/false): Make the ETA public. Default: `false`.
- Custom fields (`custom_fields`, object): Values for the company's custom post fields, as {"Field name": value}. Values must suit each field's type.
- Created at (`created_at`, date and time): Back-date the post to this date and time.

**Outputs**

- `post_id` (text): The new post's id

**Example output**

```json
{
  "post_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Create tag

Add a tag to a board. If it already has a tag of that name, that tag is returned.

**Inputs**

- Board (`board_id`, text, required): The board. Pick one, or give its id from an earlier step.
- Name (`name`, text, required): The tag's name, 1 to 30 characters.

**Outputs**

- `tag` (object): The tag

**Example output**

```json
{
  "tag": {
    "board": {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    },
    "created": "2026-01-02T10:00:00.000Z",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "name": "enterprise",
    "postCount": 3,
    "url": "https://acme.canny.io/feature-requests?tags=enterprise"
  }
}
```

### Delete category

Delete a category. It must have no subcategories; its posts stay, without a category.

**Inputs**

- Category (`category_id`, text): The category. Pick one, or give its id from an earlier step.

**Outputs**

- `category_id` (text): The deleted category's id
- `deleted` (true/false): True once Canny confirms it

**Example output**

```json
{
  "category_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "deleted": true
}
```

### Delete changelog entry

Delete a changelog entry.

**Inputs**

- Entry ID (`entry_id`, text, required): The changelog entry's id, from 'List changelog entries' or 'Create changelog entry'.

**Outputs**

- `deleted` (true/false): True once Canny confirms it
- `entry_id` (text): The deleted entry's id

**Example output**

```json
{
  "deleted": true,
  "entry_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Delete comment

Delete a comment.

**Inputs**

- Comment ID (`comment_id`, text, required): The comment's id, from 'List comments' or 'Create comment'.

**Outputs**

- `comment_id` (text): The deleted comment's id
- `deleted` (true/false): True once Canny confirms it

**Example output**

```json
{
  "comment_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "deleted": true
}
```

### Delete post

Delete a post for good, with its comments and votes.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.

**Outputs**

- `deleted` (true/false): True once Canny confirms it
- `post_id` (text): The deleted post's id

**Example output**

```json
{
  "deleted": true,
  "post_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Delete user

Delete a user, with all their comments and votes.

**Inputs**

- Canny ID (`canny_id`, text, required): The user's Canny id, from 'Get user' or 'Create or update user'.

**Outputs**

- `deleted` (true/false): True once Canny confirms it
- `id` (text): The deleted user's id

**Example output**

```json
{
  "deleted": true,
  "id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Get board

Get one board with its name, privacy and number of posts.

**Inputs**

- Board (`board_id`, text, required): The board. Pick one, or give its id from an earlier step.

**Outputs**

- `board` (object): The board

**Example output**

```json
{
  "board": {
    "created": "2026-01-01T10:00:00.000Z",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "isPrivate": false,
    "name": "Feature Requests",
    "postCount": 12,
    "privateComments": false,
    "url": "https://acme.canny.io/feature-requests"
  }
}
```

### Get post

Get one post with its author, board, category, tags, status and vote count.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.

**Outputs**

- `post` (object): The post

**Example output**

```json
{
  "post": {
    "author": {
      "alias": "jo",
      "avatarURL": "",
      "companies": [],
      "created": "2026-01-05T10:00:00.000Z",
      "customFields": {},
      "email": "jo@example.com",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isAdmin": false,
      "lastActivity": "2026-02-01T09:00:00.000Z",
      "name": "Jo Bloggs",
      "url": "https://acme.canny.io/admin/users/jo",
      "userID": "usr_123"
    },
    "board": {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    },
    "by": null,
    "category": {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "Integrations",
      "parentID": "",
      "postCount": 4,
      "url": "https://acme.canny.io/feature-requests?category=integrations"
    },
    "commentCount": 2,
    "created": "2026-01-10T10:00:00.000Z",
    "customFields": {},
    "details": "Please add a dark theme.",
    "eta": "03/2027",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "imageURLs": [],
    "owner": null,
    "score": 14,
    "status": "planned",
    "statusChangedAt": "2026-02-01T10:00:00.000Z",
    "tags": [
      {
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "created": "2026-01-02T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "name": "enterprise",
        "postCount": 3,
        "url": "https://acme.canny.io/feature-requests?tags=enterprise"
      }
    ],
    "title": "Dark mode",
    "url": "https://acme.canny.io/feature-requests/p/dark-mode"
  }
}
```

### Get user

Find one user by their Canny id, your own id for them, or their email. Give exactly one.

**Inputs**

- Canny ID (`canny_id`, text): The user's Canny id.
- Your user ID (`external_id`, text): The id your own app uses for the user.
- Email (`email`, text): The user's email address.

**Outputs**

- `user` (object): The user

**Example output**

```json
{
  "user": {
    "alias": "jo",
    "avatarURL": "",
    "companies": [],
    "created": "2026-01-05T10:00:00.000Z",
    "customFields": {},
    "email": "jo@example.com",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "isAdmin": false,
    "lastActivity": "2026-02-01T09:00:00.000Z",
    "name": "Jo Bloggs",
    "url": "https://acme.canny.io/admin/users/jo",
    "userID": "usr_123"
  }
}
```

### List boards

List every board in the company, with its name, privacy and number of posts.

**Inputs**: None.

**Outputs**

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

**Example output**

```json
{
  "boards": [
    {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    }
  ],
  "count": 1
}
```

### List categories

List categories, of one board or of every board. Returns one page; pass 'next_skip' as 'skip' for more.

**Inputs**

- Board (`board_id`, text): The board. Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Records to skip (`skip`, number): How many to skip, to get the next page: pass 'next_skip' from the last page. At least 0.

**Outputs**

- `categories` (list): The categories
- `count` (number): How many came back
- `has_more` (true/false): Whether more remain
- `next_skip` (number): 'skip' for the next page, empty on the last

**Example output**

```json
{
  "categories": [
    {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "Integrations",
      "parentID": "",
      "postCount": 4,
      "url": "https://acme.canny.io/feature-requests?category=integrations"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_skip": null
}
```

### List changelog entries

List changelog entries, filtered by status, type or label. Returns one page; pass 'next_skip' as 'skip' for more.

**Inputs**

- Status (`status`, list): Only entries in one of these statuses. Leave empty for all. One or more of: `draft`, `scheduled`, `published`.
- Type (`type`, text): Only this kind of entry. One of: `new`, `improved`, `fixed`.
- Label IDs (`label_ids`, list): The ids of the changelog labels, from an earlier entry's labels.
- Order (`sort`, text): How to order the entries. One of: `nonPublishedFirst` (Drafts and scheduled first (default)), `created` (Newest created), `lastSaved` (Last saved), `publishedAt` (Newest published).
- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Records to skip (`skip`, number): How many to skip, to get the next page: pass 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many came back
- `entries` (list): The entries
- `has_more` (true/false): Whether more remain
- `next_skip` (number): 'skip' for the next page, empty on the last

**Example output**

```json
{
  "count": 1,
  "entries": [
    {
      "created": "2026-02-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "labels": [],
      "lastSaved": "2026-02-01T10:00:00.000Z",
      "markdownDetails": "You can now switch to a dark theme.",
      "plaintextDetails": "You can now switch to a dark theme.",
      "posts": [],
      "publishedAt": "2026-02-01T10:00:00.000Z",
      "scheduledFor": "",
      "status": "published",
      "title": "Dark mode is here",
      "types": [
        "new"
      ],
      "url": "https://acme.canny.io/changelog/dark-mode-is-here"
    }
  ],
  "has_more": false,
  "next_skip": null
}
```

### List comments

List comments, of one post, board, author or company, or all of them. Returns one page; pass 'next_cursor' as 'cursor' for more.

**Inputs**

- Post ID (`post_id`, text): The post's id, from 'List posts', 'Create post' or an earlier step.
- Board (`board_id`, text): The board. Pick one, or give its id from an earlier step.
- Author (`author_id`, text): Only comments by this user. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Company ID (`company_id`, text): Only comments by users of this company.
- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `comments` (list): The comments
- `count` (number): How many came back
- `has_next_page` (true/false): Whether more remain
- `next_cursor` (text): 'cursor' for the next page

**Example output**

```json
{
  "comments": [
    {
      "author": {
        "alias": "jo",
        "avatarURL": "",
        "companies": [],
        "created": "2026-01-05T10:00:00.000Z",
        "customFields": {},
        "email": "jo@example.com",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isAdmin": false,
        "lastActivity": "2026-02-01T09:00:00.000Z",
        "name": "Jo Bloggs",
        "url": "https://acme.canny.io/admin/users/jo",
        "userID": "usr_123"
      },
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-11T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "imageURLs": [],
      "internal": false,
      "likeCount": 1,
      "parentID": "",
      "post": {
        "author": {
          "alias": "jo",
          "avatarURL": "",
          "companies": [],
          "created": "2026-01-05T10:00:00.000Z",
          "customFields": {},
          "email": "jo@example.com",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isAdmin": false,
          "lastActivity": "2026-02-01T09:00:00.000Z",
          "name": "Jo Bloggs",
          "url": "https://acme.canny.io/admin/users/jo",
          "userID": "usr_123"
        },
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "by": null,
        "category": {
          "board": {
            "created": "2026-01-01T10:00:00.000Z",
            "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
            "isPrivate": false,
            "name": "Feature Requests",
            "postCount": 12,
            "privateComments": false,
            "url": "https://acme.canny.io/feature-requests"
          },
          "created": "2026-01-02T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "name": "Integrations",
          "parentID": "",
          "postCount": 4,
          "url": "https://acme.canny.io/feature-requests?category=integrations"
        },
        "commentCount": 2,
        "created": "2026-01-10T10:00:00.000Z",
        "customFields": {},
        "details": "Please add a dark theme.",
        "eta": "03/2027",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "imageURLs": [],
        "owner": null,
        "score": 14,
        "status": "planned",
        "statusChangedAt": "2026-02-01T10:00:00.000Z",
        "tags": [
          {
            "board": {
              "created": "2026-01-01T10:00:00.000Z",
              "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
              "isPrivate": false,
              "name": "Feature Requests",
              "postCount": 12,
              "privateComments": false,
              "url": "https://acme.canny.io/feature-requests"
            },
            "created": "2026-01-02T10:00:00.000Z",
            "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
            "name": "enterprise",
            "postCount": 3,
            "url": "https://acme.canny.io/feature-requests?tags=enterprise"
          }
        ],
        "title": "Dark mode",
        "url": "https://acme.canny.io/feature-requests/p/dark-mode"
      },
      "private": false,
      "value": "We are looking into it."
    }
  ],
  "count": 1,
  "has_next_page": false,
  "next_cursor": ""
}
```

### List posts

List posts, filtered by board, author, company, tags, status or a search. Returns one page; pass 'next_skip' as 'skip' for more.

**Inputs**

- Board (`board_id`, text): The board. Pick one, or give its id from an earlier step.
- Author (`author_id`, text): Only posts by this user. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Company ID (`company_id`, text): Only posts by users of this company.
- Tags (`tag_ids`, list): Only posts with one of these tags.
- Status (`status`, list): Only posts in one of these statuses. Leave empty for all. One or more of: `open`, `under review`, `planned`, `in progress`, `complete`, `closed`.
- Search (`search`, text): Words to look for in titles and details.
- Order (`sort`, text): How to order the posts. Defaults to newest first. One of: `newest` (Newest first (default)), `oldest` (Oldest first), `score` (Most votes), `trending`, `statusChanged` (Status changed most recently), `relevance` (Most relevant (needs a search)).
- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Records to skip (`skip`, number): How many to skip, to get the next page: pass 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many came back
- `has_more` (true/false): Whether more remain
- `next_skip` (number): 'skip' for the next page, empty on the last
- `posts` (list): The posts

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_skip": null,
  "posts": [
    {
      "author": {
        "alias": "jo",
        "avatarURL": "",
        "companies": [],
        "created": "2026-01-05T10:00:00.000Z",
        "customFields": {},
        "email": "jo@example.com",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isAdmin": false,
        "lastActivity": "2026-02-01T09:00:00.000Z",
        "name": "Jo Bloggs",
        "url": "https://acme.canny.io/admin/users/jo",
        "userID": "usr_123"
      },
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "by": null,
      "category": {
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "created": "2026-01-02T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "name": "Integrations",
        "parentID": "",
        "postCount": 4,
        "url": "https://acme.canny.io/feature-requests?category=integrations"
      },
      "commentCount": 2,
      "created": "2026-01-10T10:00:00.000Z",
      "customFields": {},
      "details": "Please add a dark theme.",
      "eta": "03/2027",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "imageURLs": [],
      "owner": null,
      "score": 14,
      "status": "planned",
      "statusChangedAt": "2026-02-01T10:00:00.000Z",
      "tags": [
        {
          "board": {
            "created": "2026-01-01T10:00:00.000Z",
            "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
            "isPrivate": false,
            "name": "Feature Requests",
            "postCount": 12,
            "privateComments": false,
            "url": "https://acme.canny.io/feature-requests"
          },
          "created": "2026-01-02T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "name": "enterprise",
          "postCount": 3,
          "url": "https://acme.canny.io/feature-requests?tags=enterprise"
        }
      ],
      "title": "Dark mode",
      "url": "https://acme.canny.io/feature-requests/p/dark-mode"
    }
  ]
}
```

### List tags

List tags, of one board or of every board. Returns one page; pass 'next_skip' as 'skip' for more.

**Inputs**

- Board (`board_id`, text): The board. Pick one, or give its id from an earlier step.
- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Records to skip (`skip`, number): How many to skip, to get the next page: pass 'next_skip' from the last page. At least 0.

**Outputs**

- `count` (number): How many came back
- `has_more` (true/false): Whether more remain
- `next_skip` (number): 'skip' for the next page, empty on the last
- `tags` (list): The tags

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "next_skip": null,
  "tags": [
    {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "enterprise",
      "postCount": 3,
      "url": "https://acme.canny.io/feature-requests?tags=enterprise"
    }
  ]
}
```

### List users

List the company's users. Returns one page; pass 'next_cursor' as 'cursor' for more.

**Inputs**

- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back
- `has_next_page` (true/false): Whether more remain
- `next_cursor` (text): 'cursor' for the next page
- `users` (list): The users

**Example output**

```json
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "users": [
    {
      "alias": "jo",
      "avatarURL": "",
      "companies": [],
      "created": "2026-01-05T10:00:00.000Z",
      "customFields": {},
      "email": "jo@example.com",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isAdmin": false,
      "lastActivity": "2026-02-01T09:00:00.000Z",
      "name": "Jo Bloggs",
      "url": "https://acme.canny.io/admin/users/jo",
      "userID": "usr_123"
    }
  ]
}
```

### List votes

List votes, of one post, board, voter or company, or all of them. Returns one page; pass 'next_cursor' as 'cursor' for more.

**Inputs**

- Post ID (`post_id`, text): The post's id, from 'List posts', 'Create post' or an earlier step.
- Board (`board_id`, text): The board. Pick one, or give its id from an earlier step.
- Voter (`voter_id`, text): Only votes by this user. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Company ID (`company_id`, text): Only votes by users of this company.
- Page size (`limit`, number): How many to return, 1 to 100. Canny's default is 10. From 1 to 100.
- Next page cursor (`cursor`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back
- `has_next_page` (true/false): Whether more remain
- `next_cursor` (text): 'cursor' for the next page
- `votes` (list): The votes

**Example output**

```json
{
  "count": 1,
  "has_next_page": false,
  "next_cursor": "",
  "votes": [
    {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "by": null,
      "created": "2026-01-12T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "post": {
        "author": {
          "alias": "jo",
          "avatarURL": "",
          "companies": [],
          "created": "2026-01-05T10:00:00.000Z",
          "customFields": {},
          "email": "jo@example.com",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isAdmin": false,
          "lastActivity": "2026-02-01T09:00:00.000Z",
          "name": "Jo Bloggs",
          "url": "https://acme.canny.io/admin/users/jo",
          "userID": "usr_123"
        },
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "by": null,
        "category": {
          "board": {
            "created": "2026-01-01T10:00:00.000Z",
            "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
            "isPrivate": false,
            "name": "Feature Requests",
            "postCount": 12,
            "privateComments": false,
            "url": "https://acme.canny.io/feature-requests"
          },
          "created": "2026-01-02T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "name": "Integrations",
          "parentID": "",
          "postCount": 4,
          "url": "https://acme.canny.io/feature-requests?category=integrations"
        },
        "commentCount": 2,
        "created": "2026-01-10T10:00:00.000Z",
        "customFields": {},
        "details": "Please add a dark theme.",
        "eta": "03/2027",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "imageURLs": [],
        "owner": null,
        "score": 14,
        "status": "planned",
        "statusChangedAt": "2026-02-01T10:00:00.000Z",
        "tags": [
          {
            "board": {
              "created": "2026-01-01T10:00:00.000Z",
              "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
              "isPrivate": false,
              "name": "Feature Requests",
              "postCount": 12,
              "privateComments": false,
              "url": "https://acme.canny.io/feature-requests"
            },
            "created": "2026-01-02T10:00:00.000Z",
            "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
            "name": "enterprise",
            "postCount": 3,
            "url": "https://acme.canny.io/feature-requests?tags=enterprise"
          }
        ],
        "title": "Dark mode",
        "url": "https://acme.canny.io/feature-requests/p/dark-mode"
      },
      "votePriority": "",
      "voter": {
        "alias": "jo",
        "avatarURL": "",
        "companies": [],
        "created": "2026-01-05T10:00:00.000Z",
        "customFields": {},
        "email": "jo@example.com",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isAdmin": false,
        "lastActivity": "2026-02-01T09:00:00.000Z",
        "name": "Jo Bloggs",
        "url": "https://acme.canny.io/admin/users/jo",
        "userID": "usr_123"
      }
    }
  ]
}
```

### Publish or unpublish changelog entry

Publish an entry, schedule it for later, or turn it back into a draft.

**Inputs**

- Entry ID (`entry_id`, text, required): The changelog entry's id, from 'List changelog entries' or 'Create changelog entry'.
- Status (`status`, text, required): Published, scheduled or draft. One of: `draft`, `scheduled`, `published`.
- Published on (`published_on`, date and time): A date and time in the past to show as the publish time.
- Schedule for (`scheduled_for`, date and time): A date and time in the future to publish the entry.

**Outputs**

- `entry_id` (text): The entry's id
- `status` (text): Its new status

**Example output**

```json
{
  "entry_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "status": "published"
}
```

### Remove tag from post

Take a tag off a post.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Tag (`tag_id`, text, required): The tag. Pick one, or give its id from an earlier step.

**Outputs**

- `post` (object): The updated post

**Example output**

```json
{
  "post": {
    "author": {
      "alias": "jo",
      "avatarURL": "",
      "companies": [],
      "created": "2026-01-05T10:00:00.000Z",
      "customFields": {},
      "email": "jo@example.com",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isAdmin": false,
      "lastActivity": "2026-02-01T09:00:00.000Z",
      "name": "Jo Bloggs",
      "url": "https://acme.canny.io/admin/users/jo",
      "userID": "usr_123"
    },
    "board": {
      "created": "2026-01-01T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "isPrivate": false,
      "name": "Feature Requests",
      "postCount": 12,
      "privateComments": false,
      "url": "https://acme.canny.io/feature-requests"
    },
    "by": null,
    "category": {
      "board": {
        "created": "2026-01-01T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "isPrivate": false,
        "name": "Feature Requests",
        "postCount": 12,
        "privateComments": false,
        "url": "https://acme.canny.io/feature-requests"
      },
      "created": "2026-01-02T10:00:00.000Z",
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "name": "Integrations",
      "parentID": "",
      "postCount": 4,
      "url": "https://acme.canny.io/feature-requests?category=integrations"
    },
    "commentCount": 2,
    "created": "2026-01-10T10:00:00.000Z",
    "customFields": {},
    "details": "Please add a dark theme.",
    "eta": "03/2027",
    "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
    "imageURLs": [],
    "owner": null,
    "score": 14,
    "status": "planned",
    "statusChangedAt": "2026-02-01T10:00:00.000Z",
    "tags": [
      {
        "board": {
          "created": "2026-01-01T10:00:00.000Z",
          "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
          "isPrivate": false,
          "name": "Feature Requests",
          "postCount": 12,
          "privateComments": false,
          "url": "https://acme.canny.io/feature-requests"
        },
        "created": "2026-01-02T10:00:00.000Z",
        "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
        "name": "enterprise",
        "postCount": 3,
        "url": "https://acme.canny.io/feature-requests?tags=enterprise"
      }
    ],
    "title": "Dark mode",
    "url": "https://acme.canny.io/feature-requests/p/dark-mode"
  }
}
```

### Remove vote

Take a user's vote off a post.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Voter (`voter_id`, text, required): Whose vote to remove. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).

**Outputs**

- `post_id` (text): The post's id
- `removed` (true/false): True once Canny confirms it
- `voter_id` (text): The voter's id

**Example output**

```json
{
  "post_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "removed": true,
  "voter_id": "5f8a1b2c3d4e5f6a7b8c9d0e"
}
```

### Update changelog entry

Change an entry's title, text, type, labels or linked posts. Empty fields are left as they are.

**Inputs**

- Entry ID (`entry_id`, text, required): The changelog entry's id, from 'List changelog entries' or 'Create changelog entry'.
- Title (`title`, text): The entry's title, up to 400 characters.
- Details (`details`, text): The entry's text, in Markdown.
- Type (`type`, text): What kind of change it is. One of: `new`, `improved`, `fixed`.
- Email subscribers (`notify`, true/false): Tell the entry's subscribers when it is published. Default: `false`.
- Label IDs (`label_ids`, list): The ids of the changelog labels, from an earlier entry's labels.
- Linked post IDs (`post_ids`, list): The ids of posts this entry is about; their voters can be told when it is published.

**Outputs**

- `entry_id` (text): The entry's id
- `updated` (true/false): True once Canny confirms it

**Example output**

```json
{
  "entry_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "updated": true
}
```

### Update post

Change a post's title, details, owner, ETA or custom fields. Empty fields are left as they are.

**Inputs**

- Post ID (`post_id`, text, required): The post's id, from 'List posts', 'Create post' or an earlier step.
- Title (`title`, text): A new title, up to 400 characters.
- Details (`details`, text): New text, up to 10,000 characters.
- Owner (`owner_id`, text): The admin responsible for it. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- Changed by (`changer_id`, text): Who is making the change. Needed when you set an owner. The Canny id of a user, from 'Get user', 'List users' or 'Create or update user' (not your own user id).
- ETA (`eta`, date): When the work should be done. Canny keeps the month and year.
- Show ETA to everyone (`eta_public`, true/false): Make the ETA public. Default: `false`.
- Custom fields (`custom_fields`, object): Values for the company's custom post fields, as {"Field name": value}. Values must suit each field's type.

**Outputs**

- `post_id` (text): The post's id
- `updated` (true/false): True once Canny confirms it

**Example output**

```json
{
  "post_id": "5f8a1b2c3d4e5f6a7b8c9d0e",
  "updated": true
}
```
