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

# Schedule report options

> Fetch report types, frequencies, and recipient limit for the EcoMail Hub schedule-report form.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /schedule-reports/options
openapi: 3.1.0
info:
  title: YouNegotiate EcoMail Hub API
  version: '2.0'
  description: Stateless API endpoints for EcoMail Hub / EcoPortal users.
servers:
  - url: https://api.ecomailhub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public EcoMail Hub domain system and health endpoints.
  - name: Authentication
    description: EcoMail Hub login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated EcoMail Hub user profile endpoints.
  - name: Dashboard
    description: EcoMail Hub dashboard summary and notice-response bucket endpoints.
  - name: Manage Consumers
    description: >-
      EcoMail Hub consumer identity grouping and notice-response count
      endpoints.
  - name: Manage Creditors
    description: >-
      EcoMail Hub creditor profile and company-only member profile table
      endpoints.
  - name: Import Creditor Profiles
    description: EcoMail Hub creditor profile CSV import endpoints.
  - name: Manage Notice Response
    description: >-
      EcoMail Hub top-level notice-response review, reassignment, and close
      endpoints.
  - name: Manage Users
    description: EcoMail Hub user account management endpoints.
  - name: Reports
    description: EcoMail Hub one-time and scheduled CSV report endpoints.
  - name: Communications
    description: EcoMail Hub communication template editor endpoints.
paths:
  /schedule-reports/options:
    get:
      tags:
        - Reports
      summary: Schedule report options
      description: >-
        Fetch report types, frequencies, and recipient limit for the EcoMail Hub
        schedule-report form.
      operationId: ecomailhubScheduleReportOptions
      responses:
        '200':
          description: Schedule report options returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EcomailhubScheduleReportOptionsResponse'
              example:
                data:
                  report_types:
                    - value: creditor_profiles
                      label: Creditor Profiles
                      requires_date_range: true
                    - value: notice_responses
                      label: Notice Responses
                      requires_date_range: true
                    - value: consumer_profiles
                      label: Consumer Profiles
                      requires_date_range: true
                  frequencies:
                    - value: daily
                      label: Daily
                    - value: weekly
                      label: Weekly
                    - value: monthly
                      label: Monthly
                  max_recipients: 5
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    EcomailhubScheduleReportOptionsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - report_types
            - frequencies
            - max_recipients
          properties:
            report_types:
              type: array
              items:
                $ref: '#/components/schemas/EcomailhubReportTypeOption'
            frequencies:
              type: array
              items:
                $ref: '#/components/schemas/EcomailhubScheduleReportFrequencyOption'
            max_recipients:
              type: integer
              example: 5
    EcomailhubReportTypeOption:
      type: object
      required:
        - value
        - label
        - requires_date_range
      properties:
        value:
          type: string
          enum:
            - creditor_profiles
            - notice_responses
            - consumer_profiles
        label:
          type: string
          enum:
            - Creditor Profiles
            - Notice Responses
            - Consumer Profiles
        requires_date_range:
          type: boolean
          example: true
    EcomailhubScheduleReportFrequencyOption:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: string
          enum:
            - daily
            - weekly
            - monthly
        label:
          type: string
          enum:
            - Daily
            - Weekly
            - Monthly
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum

````