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

# List group form options

> Return company scope, account status, and custom date rule options for the superadmin Communications > Groups create/edit form. `uploaded_file_options` is always empty because superadmin groups are not scoped by upload file.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /communications/groups/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:
  /communications/groups/options:
    get:
      tags:
        - Communications / Groups
      summary: List group form options
      description: >-
        Return company scope, account status, and custom date rule options for
        the superadmin Communications > Groups create/edit form.
        `uploaded_file_options` is always empty because superadmin groups are
        not scoped by upload file.
      operationId: superadminListCommunicationGroupOptions
      responses:
        '200':
          description: Communication group form options returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationGroupOptionsResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    CommunicationGroupOptionsResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/CommunicationGroupOptions'
    CommunicationGroupOptions:
      type: object
      required:
        - apply_to_options
        - uploaded_file_options
        - consumer_states
        - custom_rules
      properties:
        apply_to_options:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationGroupOption'
        uploaded_file_options:
          type: array
          description: Always empty for superadmin communication groups.
          items:
            $ref: '#/components/schemas/CommunicationGroupOption'
        consumer_states:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationGroupStateOption'
        custom_rules:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationGroupCustomRuleOption'
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    CommunicationGroupOption:
      type: object
      required:
        - value
        - label
      properties:
        id:
          type: integer
          description: Present for concrete company options.
        value:
          oneOf:
            - type: integer
            - type: string
              enum:
                - all
          example: all
        label:
          type: string
          example: All companies
    CommunicationGroupStateOption:
      type: object
      required:
        - value
        - label
      properties:
        value:
          $ref: '#/components/schemas/CommunicationGroupState'
        label:
          type: string
          example: Delivered
    CommunicationGroupCustomRuleOption:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: string
          enum:
            - expiry_date
            - placement_date
        label:
          type: string
          example: Placement Date
    CommunicationGroupState:
      type: string
      enum:
        - all_active
        - not_viewed_offer
        - expired_negotiation
        - viewed_offer_but_no_response
        - open_negotiations
        - not_responded_to_counter_offer
        - negotiated_payoff_but_pending_payment
        - negotiated_plan_but_pending_payment
        - failed_or_skip_more_than_two_payments_consecutively
        - reported_not_paying
        - disputed
        - notice_response_added
        - notice_response_returned
  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

````