Canny Users API

openapi: 3.1.0
info:
  title: Canny REST Autopilot Users API
  description: 'REST API for retrieving and managing Canny customer-feedback resources:

    boards, categories, changelog entries, comments, companies, ideas, posts,

    status changes, tags, users, and votes. All requests are POST and JSON-

    bodied. Authentication is a secret API key passed in the apiKey body

    parameter (or the x-api-key header on supported endpoints).


    This specification is a best-effort, hand-authored representation of the

    publicly documented v1/v2 endpoints at https://developers.canny.io/.

    Request and response payloads are intentionally generic where the public

    docs do not enumerate the full property schema.

    '
  version: 1.0.0
  contact:
    name: Canny
    url: https://developers.canny.io/
servers:
- url: https://canny.io/api/v1
  description: Canny v1 base URL
- url: https://canny.io/api/v2
  description: Canny v2 base URL (cursor-paginated endpoints)
security:
- apiKeyBody: []
- apiKeyHeader: []
tags:
- name: Users
paths:
  /users/list:
    post:
      tags:
      - Users
      summary: List users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PagedAuthedRequest'
      responses:
        '200':
          $ref: '#/components/responses/GenericList'
  /users/retrieve:
    post:
      tags:
      - Users
      summary: Retrieve a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthedRequest'
      responses:
        '200':
          $ref: '#/components/responses/GenericObject'
  /users/create_or_update:
    post:
      tags:
      - Users
      summary: Create or update a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthedRequest'
      responses:
        '200':
          $ref: '#/components/responses/GenericObject'
  /users/delete:
    post:
      tags:
      - Users
      summary: Delete a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthedRequest'
      responses:
        '200':
          $ref: '#/components/responses/GenericObject'
  /users/remove_from_company:
    post:
      tags:
      - Users
      summary: Remove a user from a company
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthedRequest'
      responses:
        '200':
          $ref: '#/components/responses/GenericObject'
components:
  schemas:
    PagedAuthedRequest:
      allOf:
      - $ref: '#/components/schemas/AuthedRequest'
      - type: object
        properties:
          limit:
            type: integer
            description: Page size limit.
          skip:
            type: integer
            description: v1 skip-based pagination offset.
          cursor:
            type: string
            description: v2 cursor-based pagination token.
    GenericList:
      type: object
      properties:
        hasMore:
          type: boolean
        cursor:
          type: string
      additionalProperties: true
    GenericObject:
      type: object
      additionalProperties: true
    AuthedRequest:
      type: object
      required:
      - apiKey
      properties:
        apiKey:
          type: string
          description: Secret API key for the Canny company.
      additionalProperties: true
  responses:
    GenericObject:
      description: Single resource response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericObject'
    GenericList:
      description: Paginated list response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericList'
  securitySchemes:
    apiKeyBody:
      type: apiKey
      in: query
      name: apiKey
      description: 'Secret API key. Canny documents the key as a body parameter named

        `apiKey`; it is modeled here as an `apiKey` security scheme.

        '
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key