> ## 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 report matches

> The matches behind an introduction report, with participant details and feedback.



## OpenAPI

````yaml /openapi.json get /v1/introductions/{introduction_id}/report/matches
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
  - name: Account
    description: 'Owner-only workspace settings: user provisioning and feature permissions'
paths:
  /v1/introductions/{introduction_id}/report/matches:
    get:
      tags:
        - Introductions
      summary: List introduction report matches
      description: >-
        The matches behind an introduction report, with participant details and
        feedback.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9_-]+$
            description: Introduction ID
            example: H45xq8UBtUJxmSs294Gu
          required: true
          description: Introduction ID
          name: introduction_id
          in: path
        - schema:
            type: string
            format: date-time
            example: '2024-01-01T00:00:00.000Z'
            description: Filter matches from this date (ISO 8601)
          required: false
          description: Filter matches from this date (ISO 8601)
          name: start_date
          in: query
        - schema:
            type: string
            format: date-time
            example: '2024-12-31T23:59:59.999Z'
            description: Filter matches until this date (ISO 8601)
          required: false
          description: Filter matches until this date (ISO 8601)
          name: end_date
          in: query
        - schema:
            type: string
            description: Filter to a specific instance
            example: K2CC1FIYz0JGcnCsNbIa
          required: false
          description: Filter to a specific instance
          name: instance_id
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
            description: 'Maximum number of matches to return (default: 25, max: 100)'
            example: 25
          required: false
          description: 'Maximum number of matches to return (default: 25, max: 100)'
          name: limit
          in: query
        - schema:
            type: string
            maxLength: 256
            description: A match ID; returns the page after it
            example: K2CC1FIYz0JGcnCsNbIa:YG9xvAARTy5dpxqFyKpA
          required: false
          description: A match ID; returns the page after it
          name: starting_after
          in: query
        - schema:
            type: string
            maxLength: 256
            description: A match ID; returns the page before it
            example: K2CC1FIYz0JGcnCsNbIa:fn9qLqMqpPGDkn5MjXml
          required: false
          description: A match ID; returns the page before it
          name: ending_before
          in: query
      responses:
        '200':
          description: A page of matches
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntroductionMatchList'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Not allowed
          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:
    IntroductionMatchList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/IntroductionMatch'
        has_more:
          type: boolean
        url:
          type: string
      required:
        - object
        - data
        - has_more
        - url
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - authentication_error
                - invalid_request_error
                - rate_limit_error
                - not_found_error
                - permission_error
              description: The type of error returned
              example: invalid_request_error
            code:
              type: string
              nullable: true
              enum:
                - api_key_required
                - api_key_invalid
                - firebase_id_token_required
                - firebase_id_token_invalid
                - appcheck_token_required
                - appcheck_token_invalid
                - account_id_required
                - account_id_invalid
                - api_access_disabled
                - api_access_unauthorized
                - api_access_role_not_allowed
                - parameter_missing
                - parameter_invalid
                - resource_already_exists
                - resource_in_use
                - resource_not_found
                - permission_denied
                - not_implemented
                - internal_error
                - rate_limit_exceeded
                - upstream_error
                - user_not_found
                - user_not_connected_to_slack
                - user_missing_roles_for_track
                - user_already_on_track
                - user_already_completed_track
                - enrollee_already_terminal
                - track_not_active
                - track_not_enrollable
                - action_forbidden
                - api_access_plan_not_supported
                - plan_not_supported
                - draft_stale
                - invalid_cursor
                - program_archived
                - program_not_active
                - program_track_not_live
                - invalid_status_transition
                - mentorship_not_proposed
                - mentorship_ended
                - approval_waiting_on_mentor
                - no_reachable_manager
                - application_already_decided
                - participant_not_in_program
                - participant_already_answered
                - participant_not_mentor
                - reminder_pending
                - mentee_not_waiting
                - mentor_not_active
                - mentor_full
                - mentor_at_total
                - mentor_unchanged
                - same_person
                - invite_expired
                - invite_revoked
                - null
              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: tYYueINbgmmyss8O3LiD'
            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
            request_id:
              type: string
              description: ID of the request, for support
              example: req_8KSh4mNxQ1aZbPoLcVrT
          required:
            - type
            - code
            - message
            - request_id
      required:
        - error
    IntroductionMatch:
      type: object
      properties:
        object:
          type: string
          enum:
            - introduction_match
          description: Object type identifier
          example: introduction_match
        id:
          type: string
          description: 'Match identifier: the instance ID and the match''s own ID'
          example: K2CC1FIYz0JGcnCsNbIa:YG9xvAARTy5dpxqFyKpA
        introduction_id:
          type: string
          description: Parent introduction ID
          example: H45xq8UBtUJxmSs294Gu
        instance_id:
          type: string
          description: Parent instance ID
          example: K2CC1FIYz0JGcnCsNbIa
        participants:
          type: array
          items:
            $ref: '#/components/schemas/IntroductionMatchParticipant'
          description: Match participants
        matched_at:
          type: string
          nullable: true
          format: date-time
          example: '2024-02-01T09:00:00.000Z'
          description: ISO 8601 timestamp when matched
        has_scheduled_event:
          type: boolean
          description: Whether a meeting was scheduled
          example: true
        scheduled_event_at:
          type: string
          nullable: true
          format: date-time
          example: '2024-02-01T10:00:00.000Z'
          description: ISO 8601 timestamp when event was scheduled
        has_linked_calendar:
          type: boolean
          description: Whether a calendar is linked
          example: true
        has_said_met:
          type: boolean
          description: >-
            Whether participants confirmed they met (outside of calendar
            confirmation)
          example: false
        said_met_at:
          type: string
          nullable: true
          format: date-time
          example: null
          description: ISO 8601 timestamp when they confirmed meeting
        reminder_sent:
          type: boolean
          description: Whether a reminder was sent
          example: true
        nominated_organiser:
          type: object
          nullable: true
          properties:
            user_id:
              type: string
            slack_user_id:
              type: string
          required:
            - user_id
            - slack_user_id
          description: Nominated meeting organiser (group introductions only)
        feedback:
          type: object
          nullable: true
          properties:
            survey_id:
              type: string
            instance_id:
              type: string
              nullable: true
            response_count:
              type: integer
            recipient_count:
              type: integer
            status:
              type: string
              enum:
                - scheduled
                - sent
                - canceled
            scheduled_at:
              type: string
              nullable: true
              format: date-time
              example: '2026-02-01T10:30:00.000Z'
            delivered_at:
              type: string
              nullable: true
              format: date-time
              example: '2026-02-01T10:30:00.000Z'
            anonymous:
              type: boolean
            responses:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  respondent:
                    type: object
                    nullable: true
                    properties:
                      user_id:
                        type: string
                        description: Doozy user ID
                        example: 06gPNJbvBuM2i8BKRXct
                      slack_user_id:
                        type: string
                        nullable: true
                        description: Slack user ID
                        example: U1234567890
                      display_name:
                        type: string
                        nullable: true
                        description: User's display name
                        example: John Doe
                      email:
                        type: string
                        nullable: true
                        description: User's email address
                        example: john@example.com
                      department:
                        type: string
                        nullable: true
                        description: User's department/group
                        example: Engineering
                      location:
                        type: string
                        nullable: true
                        description: User's work location
                        example: San Francisco, CA
                      manager_name:
                        type: string
                        nullable: true
                        description: Manager's display name
                        example: Jane Smith
                      manager_email:
                        type: string
                        nullable: true
                        description: Manager's email address
                        example: jane@example.com
                    required:
                      - user_id
                      - slack_user_id
                      - display_name
                      - email
                      - department
                      - location
                      - manager_name
                      - manager_email
                  feedback_about:
                    type: array
                    items:
                      $ref: '#/components/schemas/IntroductionMatchParticipant'
                  responded_at:
                    type: string
                    nullable: true
                    format: date-time
                    example: '2026-02-01T10:30:00.000Z'
                  answers:
                    type: array
                    items:
                      type: object
                      properties:
                        question_id:
                          type: string
                        question_text:
                          type: string
                        question_type:
                          type: string
                          enum:
                            - scale_1_to_10
                            - scale_1_to_5
                            - emoji_1_to_5
                            - agree_disagree
                            - enps
                            - open_ended
                            - multiple_choice
                        value:
                          anyOf:
                            - type: string
                            - type: number
                            - type: array
                              items:
                                type: string
                            - nullable: true
                        comment:
                          type: string
                          nullable: true
                      required:
                        - question_id
                        - question_text
                        - question_type
                        - value
                        - comment
                required:
                  - id
                  - respondent
                  - feedback_about
                  - responded_at
                  - answers
          required:
            - survey_id
            - instance_id
            - response_count
            - recipient_count
            - status
            - scheduled_at
            - delivered_at
            - anonymous
            - responses
          description: Feedback delivery and response state for this match
      required:
        - object
        - id
        - introduction_id
        - instance_id
        - participants
        - matched_at
        - has_scheduled_event
        - scheduled_event_at
        - has_linked_calendar
        - has_said_met
        - said_met_at
        - reminder_sent
        - nominated_organiser
        - feedback
    IntroductionMatchParticipant:
      type: object
      properties:
        user_id:
          type: string
          description: Doozy user ID
          example: 06gPNJbvBuM2i8BKRXct
        slack_user_id:
          type: string
          nullable: true
          description: Slack user ID
          example: U1234567890
        display_name:
          type: string
          nullable: true
          description: User's display name
          example: John Doe
        email:
          type: string
          nullable: true
          description: User's email address
          example: john@example.com
        department:
          type: string
          nullable: true
          description: User's department/group
          example: Engineering
        location:
          type: string
          nullable: true
          description: User's work location
          example: San Francisco, CA
        manager_name:
          type: string
          nullable: true
          description: Manager's display name
          example: Jane Smith
        manager_email:
          type: string
          nullable: true
          description: Manager's email address
          example: jane@example.com
      required:
        - user_id
        - slack_user_id
        - display_name
        - email
        - department
        - location
        - manager_name
        - manager_email
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Generate keys in the Doozy dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.