Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canny Posts API

The Posts API from Canny — 13 operation(s) for posts.

Canny Posts API is one of 16 APIs that Canny publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Posts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 13 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://canny.io/api/v1, https://canny.io/api/v2.

13 operations 13 paths 4 schemas 13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://canny.io/api/v1
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Canny Posts API declares 2 security schemes for authenticating requests. An API key is passed in the query as apiKey (apiKeyBody). An API key is passed in the header as x-api-key (apiKeyHeader). By default, every request must be authenticated.

  • apiKeyBody — Secret API key. Canny documents the key as a body parameter named apiKey; it is modeled here as an apiKey security scheme.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 13 POST. Each is listed below with its method, path, parameters, and response codes.

Posts 13
POST
/posts/retrieve
Retrieve a post
body → 200
POST
/posts/list
List posts
body → 200
POST
/posts/create
Create a post
body → 200
POST
/posts/change_board
Move a post to another board
body → 200
POST
/posts/change_category
Change a post's category
body → 200
POST
/posts/change_status
Change a post's status
body → 200
POST
/posts/merge
Merge two posts
body → 200
POST
/posts/add_tag
Add a tag to a post
body → 200
POST
/posts/remove_tag
Remove a tag from a post
body → 200
POST
/posts/update
Update a post
body → 200
POST
/posts/delete
Delete a post
body → 200
POST
/posts/link_jira
Link a post to a Jira issue
body → 200
POST
/posts/unlink_jira
Unlink a post from a Jira issue
body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are GenericList (2 properties), AuthedRequest (1 property). Each schema is shown below with its type and property counts.

PagedAuthedRequest
GenericList
object
2 properties
GenericObject
object
AuthedRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canny-posts-api-openapi.yml Raw ↑

Other APIs Canny publishes across the network.

Canny REST API
Canny Autopilot API
Canny Boards API
Canny Categories API
Canny ChangelogEntries API
Canny Comments API
Canny Companies API
Canny Groups API
Canny Ideas API
Canny Insights API
Canny Opportunities API
Canny StatusChanges API