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

# List introduction instances

> List all instances (rounds) for a specific introduction. Each instance represents one matching cycle. Results are paginated and sorted by match date (newest first).



## OpenAPI

````yaml /openapi.json get /v1/introductions/{introductionId}/instances
openapi: 3.0.3
info:
  title: Doozy Public API
  version: 1.0.0
  description: >-
    The Doozy Public API allows you to programmatically access your
    organization's data.


    ## Authentication


    All API requests require an API key passed in the `x-api-key` header.


    ```

    x-api-key: dzy_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    ```


    API keys can be generated and managed through the Doozy dashboard. Each key
    is associated with a user account and inherits that user's permissions.


    ## Rate Limiting


    API requests are rate limited. Rate limiting is handled by Cloudflare. If
    you exceed the rate limit, you'll receive a 429 Too Many Requests response.


    ## Pagination


    List endpoints support cursor-based pagination using `limit` and
    `starting_after` query parameters.
  contact:
    name: Doozy Support
    email: support@doozy.live
    url: https://help.doozy.live/api
servers:
  - url: https://api.doozy.live
    description: Production
security:
  - apiKey: []
tags:
  - name: Quizzes
    description: Quiz analytics and reporting endpoints
  - name: Tracks
    description: Track management and analytics endpoints
  - name: Surveys
    description: Survey and poll analytics endpoints
  - name: Introductions
    description: Doozy Roulette and Matchmaking introduction endpoints
paths:
  /v1/introductions/{introductionId}/instances:
    get:
      tags:
        - Introductions
      summary: List introduction instances
      description: >-
        List all instances (rounds) for a specific introduction. Each instance
        represents one matching cycle. Results are paginated and sorted by match
        date (newest first).
      parameters:
        - schema:
            type: string
            description: Introduction ID
            example: intro_abc123
          required: true
          description: Introduction ID
          name: introductionId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
            description: 'Maximum number of results to return (default: 25, max: 100)'
            example: 25
          required: false
          description: 'Maximum number of results to return (default: 25, max: 100)'
          name: limit
          in: query
        - schema:
            type: string
            description: Cursor for pagination
            example: inst_abc123
          required: false
          description: Cursor for pagination
          name: starting_after
          in: query
      responses:
        '200':
          description: List of introduction instances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntroductionInstanceListResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required - missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Introduction not found or user does not have access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKey: []
components:
  schemas:
    IntroductionInstanceListResponse:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
          description: String representing the object type
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/IntroductionInstance'
          description: Array of instance objects
        has_more:
          type: boolean
          description: Whether there are more results available beyond this page
          example: true
        url:
          type: string
          description: The URL for accessing this list endpoint
          example: /v1/introductions/intro_abc123/instances
        next_cursor:
          type: string
          nullable: true
          description: >-
            Cursor to fetch the next page of results. Pass as starting_after in
            subsequent requests.
          example: inst_xyz789
        previous_cursor:
          type: string
          nullable: true
          description: >-
            Cursor to fetch the previous page of results. Pass as ending_before
            in subsequent requests.
          example: inst_abc123
      required:
        - object
        - data
        - has_more
        - url
        - next_cursor
        - previous_cursor
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - authentication_error
                - invalid_request_error
                - rate_limit_error
              description: The type of error returned
              example: invalid_request_error
            code:
              type: string
              nullable: true
              description: Machine-readable error code for specific error conditions
              example: resource_not_found
            message:
              type: string
              description: Human-readable error message
              example: 'No such quiz: quiz_abc123'
            param:
              type: string
              nullable: true
              description: The parameter related to the error, if applicable
              example: id
            doc_url:
              type: string
              format: uri
              description: URL to documentation about this error
              example: https://docs.doozy.live/api/errors#resource_not_found
          required:
            - type
            - code
            - message
      required:
        - error
    IntroductionInstance:
      type: object
      properties:
        object:
          type: string
          enum:
            - introduction_instance
          description: Object type identifier
          example: introduction_instance
        id:
          type: string
          description: Unique instance identifier
          example: inst_abc123
        introduction_id:
          type: string
          description: Parent introduction ID
          example: intro_abc123
        state:
          allOf:
            - $ref: '#/components/schemas/IntroductionInstanceState'
            - description: Current instance state
              example: complete
        match_at:
          type: string
          description: ISO 8601 timestamp when matching occurred/will occur
          example: '2024-02-01T09:00:00.000Z'
        notify_at:
          type: string
          nullable: true
          description: ISO 8601 timestamp for notification (group introductions only)
          example: '2024-01-31T09:00:00.000Z'
        remind_at:
          type: string
          nullable: true
          description: ISO 8601 timestamp for reminder
          example: '2024-02-03T09:00:00.000Z'
        user_count:
          type: integer
          description: Number of users included in this instance
          example: 20
        match_count:
          type: integer
          description: Number of matches created
          example: 10
        created_at:
          type: string
          description: ISO 8601 creation timestamp
          example: '2024-01-28T10:30:00.000Z'
        updated_at:
          type: string
          nullable: true
          description: ISO 8601 last updated timestamp
          example: '2024-01-29T14:00:00.000Z'
      required:
        - object
        - id
        - introduction_id
        - state
        - match_at
        - notify_at
        - remind_at
        - user_count
        - match_count
        - created_at
        - updated_at
    IntroductionInstanceState:
      type: string
      enum:
        - upcoming
        - checking
        - checking_matches
        - creating_matches
        - complete
        - error
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Generate keys in the Doozy dashboard.

````