> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanova.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get QR Code Categories

> Retrieves all available QR Code categories. Supports optional filtering via view_type. Authentication required — include your API key in the Authorization header.

## Query Parameters

| Name        | Type     | Required | Default | Description                                                                                                   |
| :---------- | :------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------ |
| `view_type` | `string` | No       | `all`   | Filter/grouping of categories. Allowed values: `all`, `recommended`, `use_case`, `content_type`, `favourite`. |

**Behavior**

* `all` — returns a flat list of all categories.
* `recommended` — returns categories highlighted as recommended as per your industry (if provided)
* `use_case` — groups categories by common use cases (e.g., Information & Navigation).
* `content_type` — groups by content type (e.g., Redirection, Link to a Scanova Landing Page).
* `favourite` — returns user favorites if available


## OpenAPI

````yaml GET /qr/category/
openapi: 3.1.0
info:
  title: Scanova QR Code API
  description: QR Code management endpoints for creating, updating, and managing QR codes
  version: 1.0.0
servers:
  - url: https://management.scanova.io
    description: Production server
security:
  - apiKeyAuth: []
paths:
  /qr/category/:
    get:
      tags:
        - QR Code
      summary: Get QR Code Categories
      description: >-
        Retrieves all available QR code categories with optional filtering.
        Requires authentication.
      parameters:
        - name: view_type
          in: query
          description: Filter categories by view type
          required: false
          schema:
            type: string
            enum:
              - all
              - recommended
              - use_case
              - content_type
              - favourite
            default: all
          examples:
            all:
              summary: All categories
              value: all
              description: Returns all categories in a single 'All' array
            recommended:
              summary: Recommended categories
              value: recommended
              description: >-
                Returns categories grouped as 'Recommended QR Code Categories'
                and 'Other QR Code Categories'
            use_case:
              summary: Use case grouping
              value: use_case
              description: >-
                Returns categories grouped by use cases like 'Information &
                Navigation', 'Networking & Contact', etc.
            content_type:
              summary: Content type grouping
              value: content_type
              description: >-
                Returns categories grouped by content types like 'Redirection',
                'Link to a Scanova Landing Page', etc.
            favourite:
              summary: Favourite categories
              value: favourite
              description: >-
                Returns categories grouped as 'Favorites' and 'Other QR Code
                Categories'
      responses:
        '200':
          description: QR code categories grouped by type based on view_type parameter
          content:
            application/json:
              schema:
                type: object
                description: Response structure varies based on view_type parameter
                additionalProperties:
                  type: array
                  items:
                    $ref: '#/components/schemas/Category'
              examples:
                all_categories:
                  summary: All categories (view_type=all)
                  value:
                    All:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: >-
                          https://qcg-media.scanova.io/qr-category/2020/09/url.png
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
                recommended_categories:
                  summary: Recommended categories (view_type=recommended)
                  value:
                    Recommended QR Code Categories:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: >-
                          https://qcg-media.scanova.io/qr-category/2020/09/url.png
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
                    Other QR Code Categories:
                      - id: 11
                        name: Google Maps
                        slug: map
                        description: When scanned, displays location on a map.
                        preview_image: >-
                          https://qcg-media.scanova.io/qr-category/2020/09/map.png
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: >-
                          internet,maps,google,google maps,google
                          map,location,latitude,longitude,place
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/37067648509721-Create-Google-Maps-QR-Code
                        created: '2020-09-07T11:37:48.100860+05:30'
                        modified: '2025-10-16T14:56:09.946095+05:30'
                content_type_categories:
                  summary: Content type grouping (view_type=content_type)
                  value:
                    Redirection:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: >-
                          https://qcg-media.scanova.io/qr-category/2020/09/url.png
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
                        order: 0
                    Link to a Scanova Landing Page:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: null
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
                        order: 4
                use_case_categories:
                  summary: Use case grouping (view_type=use_case)
                  value:
                    Information & Navigation:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: >-
                          https://qcg-media.scanova.io/qr-category/2020/09/url.png
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
                        order: 0
                    Networking & Contact:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: null
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
                        order: 7
                favourite_categories:
                  summary: Favourite categories (view_type=favourite)
                  value:
                    Favorites: []
                    Other QR Code Categories:
                      - id: 1
                        name: Website URL
                        slug: url
                        description: When scanned, redirects user to a website.
                        preview_image: >-
                          https://qcg-media.scanova.io/qr-category/2020/09/url.png
                        allowed_qr_types: bt
                        allowed_qr_types_display: Both
                        tags: internet,website,link,url,webpage
                        is_active: true
                        is_new: false
                        has_landing_page: false
                        helpdesk_link: >-
                          https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
                        created: '2020-09-07T11:37:48.093485+05:30'
                        modified: '2025-10-16T14:50:48.791993+05:30'
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    Category:
      type: object
      properties:
        id:
          type: integer
          description: Category ID
          example: 1
        name:
          type: string
          description: Category name
          example: Website URL
        slug:
          type: string
          description: Category slug
          example: url
        description:
          type: string
          description: Category description
          example: When scanned, redirects user to a website.
        preview_image:
          type: string
          description: URL to category preview image
          example: https://qcg-media.scanova.io/qr-category/2020/09/url.png
        allowed_qr_types:
          type: string
          description: Allowed QR code types for this category
          example: bt
        allowed_qr_types_display:
          type: string
          description: Human-readable allowed QR code types
          example: Both
        tags:
          type: string
          description: Comma-separated tags for this category
          example: internet,website,link,url,webpage
        is_active:
          type: boolean
          description: Whether the category is active
          example: true
        is_new:
          type: boolean
          description: Whether this is a new category
          example: false
        has_landing_page:
          type: boolean
          description: Whether the category has a landing page
          example: false
        helpdesk_link:
          type: string
          description: URL to helpdesk documentation for this category
          example: >-
            https://support.scanova.io/hc/en-us/articles/36997331177753-Create-Website-URL-QR-Code
        created:
          type: string
          format: date-time
          description: Category creation timestamp
          example: '2020-09-07T11:37:48.093485+05:30'
        modified:
          type: string
          format: date-time
          description: Category last modification timestamp
          example: '2025-10-16T14:50:48.791993+05:30'
    AuthenticationErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Authentication error message
          example: Invalid token.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Enter your API key directly in the Authorization
        header.

````