Aha.io Idea categories API

The Idea categories API from Aha.io — 1 operation(s) for idea categories.

OpenAPI Specification

aha-idea-categories-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Aha! Account backups Idea categories API
  version: 1.0.0
  description: Complete API documentation for Aha! generated from actual test responses
  contact:
    name: Aha! Support
    url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
  description: Aha! API Server
  variables:
    account-domain:
      description: Your Aha! account domain
      default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Idea categories
paths:
  /api/v1/products/{product_id}/idea_categories:
    get:
      summary: List idea categories in a product
      description: null
      tags:
      - Idea categories
      parameters:
      - name: product_id
        in: path
        required: true
        schema:
          type: string
        description: ProductId identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/IdeacategoriesGetResponse'
              example:
                idea_categories:
                - id: '251347229'
                  name: Usability
                  parent_id: null
                  project_id: 131414752
                  created_at: '2019-01-01T00:00:00.000Z'
                - id: '552935478'
                  name: Storage
                  parent_id: null
                  project_id: 131414752
                  created_at: '2019-01-01T00:00:00.000Z'
                - id: '972845454'
                  name: Hard disk drive
                  parent_id: 552935478
                  project_id: 131414752
                  created_at: '2019-01-01T00:00:00.000Z'
                pagination:
                  total_records: 3
                  total_pages: 1
                  current_page: 1
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    IdeacategoriesGetResponse:
      type: object
      properties:
        idea_categories:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: '251347229'
              name:
                type: string
                example: Usability
              parent_id:
                type: 'null'
              project_id:
                type: integer
                example: 131414752
              created_at:
                type: string
                example: '2019-01-01T00:00:00.000Z'
            example:
              id: '251347229'
              name: Usability
              parent_id: null
              project_id: 131414752
              created_at: '2019-01-01T00:00:00.000Z'
          example:
          - id: '251347229'
            name: Usability
            parent_id: null
            project_id: 131414752
            created_at: '2019-01-01T00:00:00.000Z'
          - id: '552935478'
            name: Storage
            parent_id: null
            project_id: 131414752
            created_at: '2019-01-01T00:00:00.000Z'
          - id: '972845454'
            name: Hard disk drive
            parent_id: 552935478
            project_id: 131414752
            created_at: '2019-01-01T00:00:00.000Z'
        pagination:
          type: object
          properties:
            total_records:
              type: integer
              example: 3
            total_pages:
              type: integer
              example: 1
            current_page:
              type: integer
              example: 1
          example:
            total_records: 3
            total_pages: 1
            current_page: 1
      example:
        idea_categories:
        - id: '251347229'
          name: Usability
          parent_id: null
          project_id: 131414752
          created_at: '2019-01-01T00:00:00.000Z'
        - id: '552935478'
          name: Storage
          parent_id: null
          project_id: 131414752
          created_at: '2019-01-01T00:00:00.000Z'
        - id: '972845454'
          name: Hard disk drive
          parent_id: 552935478
          project_id: 131414752
          created_at: '2019-01-01T00:00:00.000Z'
        pagination:
          total_records: 3
          total_pages: 1
          current_page: 1
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 authentication with bearer tokens
      flows:
        authorizationCode:
          authorizationUrl: https://{account-domain}.aha.io/oauth/authorize
          tokenUrl: https://{account-domain}.aha.io/oauth/token
          scopes: {}
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys
    CookieAuth:
      type: apiKey
      in: cookie
      name: session
      description: Cookie-based authentication for web browser integration