> ## 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.

# Get schedule report options

> Return schedule-report form options for Superadmin report types, company scopes, frequencies, and email delivery.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /schedule-reports/options
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /schedule-reports/options:
    get:
      tags:
        - Export & Reporting
      summary: Get schedule report options
      description: >-
        Return schedule-report form options for Superadmin report types, company
        scopes, frequencies, and email delivery.
      operationId: superadminScheduleReportOptions
      responses:
        '200':
          description: Schedule report options returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperadminScheduleReportOptionsResponse'
              example:
                data:
                  report_types:
                    - value: super_admin_all_accounts
                      label: Super Admin Report - All Accounts
                      requires_date_range: true
                  companies:
                    - value: all_members
                      label: All Members
                  frequencies:
                    - value: daily
                      label: Daily
                    - value: weekly
                      label: Weekly
                    - value: monthly
                      label: Monthly
                  delivery_types:
                    - value: email
                      label: Email
                  sftp_connections: []
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    SuperadminScheduleReportOptionsResponse:
      type: object
      additionalProperties: false
      required:
        - data
      properties:
        data:
          type: object
          additionalProperties: false
          required:
            - report_types
            - companies
            - frequencies
            - delivery_types
            - sftp_connections
          properties:
            report_types:
              type: array
              items:
                $ref: '#/components/schemas/SuperadminReportTypeOption'
            companies:
              type: array
              items:
                $ref: '#/components/schemas/SuperadminReportCompanyOption'
            frequencies:
              type: array
              items:
                $ref: '#/components/schemas/SuperadminScheduleReportFrequencyOption'
            delivery_types:
              type: array
              items:
                $ref: >-
                  #/components/schemas/SuperadminScheduleReportDeliveryTypeOption
            sftp_connections:
              type: array
              description: >-
                Superadmin scheduled reports are email-only, so this list is
                always empty.
              maxItems: 0
              items:
                type: object
    SuperadminReportTypeOption:
      type: object
      additionalProperties: false
      required:
        - value
        - label
        - requires_date_range
      properties:
        value:
          type: string
          enum:
            - bill_pay_donations_dfa
            - invoicing
            - cogs
            - partner_summary_total
            - partner_members
            - younegotiate_revenue
            - compliance_consumer_pii_opt_out
            - compliance_consumer_disputes_no_pay
            - compliance_auto_expired_deleted_accounts
            - consumer_payments
            - super_admin_all_accounts
          example: bill_pay_donations_dfa
        label:
          type: string
          example: Bill Pay Donations Report (DFA)
        requires_date_range:
          type: boolean
          example: true
    SuperadminReportCompanyOption:
      type: object
      additionalProperties: false
      required:
        - value
        - label
      properties:
        value:
          oneOf:
            - type: string
              enum:
                - all_members
            - type: integer
          example: all_members
        label:
          type: string
          example: All Members
    SuperadminScheduleReportFrequencyOption:
      type: object
      additionalProperties: false
      required:
        - value
        - label
      properties:
        value:
          $ref: '#/components/schemas/SuperadminScheduleReportFrequency'
        label:
          type: string
          example: Daily
    SuperadminScheduleReportDeliveryTypeOption:
      type: object
      additionalProperties: false
      required:
        - value
        - label
      properties:
        value:
          $ref: '#/components/schemas/SuperadminScheduleReportDeliveryType'
        label:
          type: string
          example: Email
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    SuperadminScheduleReportFrequency:
      type: string
      enum:
        - daily
        - weekly
        - monthly
    SuperadminScheduleReportDeliveryType:
      type: string
      enum:
        - email
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````