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

# List quizzes

> List all quizzes owned by the authenticated user with cursor-based pagination.



## OpenAPI

````yaml api-reference/openapi.json get /api/v1/quizzes
openapi: 3.1.0
info:
  title: Quiz Quail API
  version: 1.0.0
  description: >-
    The Quiz Quail API lets you create, manage, and render quiz videos
    programmatically. Build quizzes with multiple rounds and question types,
    apply custom themes, render to video, upload to YouTube, and use AI to
    generate quizzes from topics.


    ## Authentication


    All endpoints require a Bearer token (API key). Include it in the
    `Authorization` header:


    ```

    Authorization: Bearer qq_your_api_key_here

    ```


    API keys can be scoped to specific permissions. See the security schemes
    below for available scopes.


    ## Rate Limiting


    Requests are rate-limited per user:

    - **Read** endpoints: 300 requests/minute

    - **Write** endpoints: 30 requests/minute

    - **AI** endpoints: 5 requests/minute

    - **Render** endpoints: 10 requests/hour


    Rate limit headers are included in every response.


    ## Pagination


    List endpoints use cursor-based pagination. Pass the `cursor` from the
    previous response to get the next page. The `hasMore` field indicates
    whether more items exist.


    ## Errors


    Errors follow [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457). Every error response
    includes `type`, `title`, `status`, and `detail` fields.
  contact:
    name: Quiz Quail
    url: https://quizquail.com
servers:
  - url: https://quizquail.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Quizzes
    description: Create and manage quizzes, rounds, and questions
  - name: Themes
    description: Create and manage visual themes for quizzes
  - name: Media
    description: Upload, manage, and search media files
  - name: Renders
    description: Render quizzes to video and download results
  - name: Thumbnails
    description: Generate video thumbnails
  - name: YouTube
    description: Upload videos to YouTube and manage uploads
  - name: Webhooks
    description: Register webhooks for event notifications
  - name: AI
    description: AI-powered quiz generation and promotion suggestions
  - name: Trends
    description: Trending topics for quiz inspiration
paths:
  /api/v1/quizzes:
    get:
      tags:
        - Quizzes
      summary: List quizzes
      description: >-
        List all quizzes owned by the authenticated user with cursor-based
        pagination.
      parameters:
        - schema:
            type: string
            description: Pagination cursor from a previous response
          required: false
          description: Pagination cursor from a previous response
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: Number of items per page (1-100, default 20)
          required: false
          description: Number of items per page (1-100, default 20)
          name: limit
          in: query
        - schema:
            type: string
            description: Filter by status (e.g. 'draft')
          required: false
          description: Filter by status (e.g. 'draft')
          name: status
          in: query
        - schema:
            type: string
            enum:
              - updated_at
              - created_at
              - title
            description: Sort field
          required: false
          description: Sort field
          name: sort
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            description: Sort order
          required: false
          description: Sort order
          name: order
          in: query
      responses:
        '200':
          description: Paginated list of quizzes
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Quiz'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                  - data
                  - pagination
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - quizzes:read
components:
  schemas:
    Quiz:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        status:
          type: string
        intro_subtitle:
          type:
            - string
            - 'null'
        outro_text:
          type:
            - string
            - 'null'
        question_duration_seconds:
          type:
            - number
            - 'null'
        answer_duration_seconds:
          type:
            - number
            - 'null'
        fact_duration_seconds:
          type:
            - number
            - 'null'
        hint_timing_percent:
          type:
            - number
            - 'null'
        resolution:
          type:
            - string
            - 'null'
        platform_profile:
          type:
            - string
            - 'null'
        theme_id:
          type:
            - string
            - 'null'
          format: uuid
        user_id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - title
        - description
        - status
        - intro_subtitle
        - outro_text
        - question_duration_seconds
        - answer_duration_seconds
        - fact_duration_seconds
        - hint_timing_percent
        - resolution
        - platform_profile
        - theme_id
        - user_id
        - created_at
        - updated_at
    Pagination:
      type: object
      properties:
        cursor:
          type:
            - string
            - 'null'
          description: Cursor for the next page, null if no more pages
        hasMore:
          type: boolean
          description: Whether there are more items after this page
        total:
          type: integer
          description: Total count of items (when available)
      required:
        - cursor
        - hasMore
    Error:
      type: object
      properties:
        type:
          type: string
          example: https://quizquail.com/problems/validation-error
        title:
          type: string
          example: Validation Error
        status:
          type: integer
          example: 400
        detail:
          type: string
          example: Request validation failed
        instance:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
      required:
        - type
        - title
        - status
    FieldError:
      type: object
      properties:
        field:
          type: string
          example: title
        message:
          type: string
          example: Title is required
        code:
          type: string
          example: too_small
      required:
        - field
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key authentication. Prefix your key with `Bearer ` in the
        Authorization header.


        Keys follow the format `qq_...` and can be scoped to specific
        permissions.

````