> ## 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 automated communication history

> List automated communication delivery history with search, filters, sorting, and pagination.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /automated-communication-history
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:
  /automated-communication-history:
    get:
      tags:
        - Automated Communications
      summary: List automated communication history
      description: >-
        List automated communication delivery history with search, filters,
        sorting, and pagination.
      operationId: superadminListAutomatedCommunicationHistory
      parameters:
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - source
              - company_name
              - consumer_name
              - template_type
              - template_name
              - cost
              - status
            default: source
        - $ref: '#/components/parameters/SortDirection'
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: template_type
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/AutomatedTemplateType'
        - name: status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/AutomatedCommunicationHistoryStatus'
        - name: source
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/AutomatedCommunicationHistorySource'
        - name: company
          in: query
          required: false
          schema:
            type: integer
        - name: subclient
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Automated communication history returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomatedCommunicationHistoryListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    SortDirection:
      name: direction
      in: query
      required: false
      description: Sort direction.
      schema:
        type: string
        enum:
          - asc
          - desc
  schemas:
    AutomatedTemplateType:
      type: string
      enum:
        - email
        - sms
    AutomatedCommunicationHistoryStatus:
      type: integer
      enum:
        - 1
        - 2
        - 3
      description: 1 is Success, 2 is Failed, and 3 is In Progress.
    AutomatedCommunicationHistorySource:
      type: string
      enum:
        - super_auto
        - super_campaign
        - creditor_profile
        - superadmin_profile
    AutomatedCommunicationHistoryListResponse:
      type: object
      required:
        - data
        - meta
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AutomatedCommunicationHistory'
        meta:
          type: object
          required:
            - total_cost
          properties:
            total_cost:
              type: number
              format: float
              description: Sum of the cost values on the returned history page.
              example: 12.75
        pagination:
          $ref: '#/components/schemas/Pagination'
    AutomatedCommunicationHistory:
      type: object
      additionalProperties: true
      properties:
        id:
          type: integer
        source:
          $ref: '#/components/schemas/AutomatedCommunicationHistorySource'
        source_label:
          type: string
          example: Super - auto
        company_name:
          type: string
          example: Alpha Recovery
        consumer_name:
          type: string
          example: Jane Consumer
        template_type:
          $ref: '#/components/schemas/AutomatedTemplateType'
        template_type_label:
          type: string
          nullable: true
          example: Email
        template_name:
          type: string
          nullable: true
          example: Welcome Email
        email:
          type: string
          format: email
          nullable: true
        phone:
          type: string
          nullable: true
        cost:
          type: number
          nullable: true
          example: 0.25
        status:
          $ref: '#/components/schemas/AutomatedCommunicationHistoryStatus'
        status_label:
          type: string
          nullable: true
          example: Success
        communication_status:
          type: object
          nullable: true
          properties:
            id:
              type: integer
            code:
              type: string
              example: '1.1'
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    Pagination:
      type: object
      required:
        - current_page
        - from
        - last_page
        - per_page
        - to
        - total
      properties:
        current_page:
          type: integer
          example: 1
        from:
          type: integer
          nullable: true
          example: 1
        last_page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        to:
          type: integer
          nullable: true
          example: 10
        total:
          type: integer
          example: 10
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````