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

> List active creditor EcoLetter campaigns with search, sorting, sub-account scoping, and pagination.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /communications/campaigns
openapi: 3.1.0
info:
  title: YouNegotiate Creditor API
  version: '2.0'
  description: >-
    Stateless API endpoints for creditor portal authentication and account
    access.
servers:
  - url: https://api.creditor.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public creditor domain system and health endpoints.
  - name: Authentication
    description: Creditor registration, login, password, and email verification endpoints.
  - name: Account Settings
    description: >-
      Authenticated creditor profile, contact, operating-hours, and
      profile-image endpoints.
  - name: Account Profile
    description: >-
      Creditor onboarding profile, membership, billing, and setup status
      endpoints.
  - name: Setup Wizard
    description: >-
      Creditor setup wizard status, required-step completion, and optional-step
      completion.
  - name: Dashboard
    description: Creditor dashboard work queues and performance widgets.
  - name: Import / Export
    description: >-
      Creditor consumer import upload sessions, queued imports, history,
      downloads, and failed-row files.
  - name: Membership Settings
    description: >-
      Creditor membership dashboard, plan changes, payment method, cancellation,
      special-plan inquiry, and over-limit retry endpoints.
  - name: Merchant Account
    description: >-
      Existing merchant processor credentials, Tilled onboarding, and merchant
      application endpoints.
  - name: Header Profiles
    description: >-
      CSV header profile upload, mapping, download, and setup wizard completion
      endpoints.
  - name: SFTP Connections
    description: >-
      Creditor-managed SFTP connection profiles for imports, exports, and setup
      wizard completion.
  - name: Sub Accounts
    description: >-
      Creditor-managed sub account list, export, create, update, and delete
      endpoints.
  - name: Pay Terms Offers
    description: >-
      Creditor-managed master, sub-account, group, and group-sub-account Pay
      Terms endpoints.
  - name: Individual Custom Offers
    description: Creditor individual custom offer list endpoints.
  - name: Negotiations
    description: >-
      Creditor negotiation work queues, including notice responses and offer
      review counts.
  - name: Communications / CFPB Validation Letter
    description: >-
      CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export,
      and print/download actions.
  - name: Communications / EcoLetter Template
    description: >-
      Creditor EcoLetter template management for secure eLetter communications
      and campaigns.
  - name: Communications / Groups
    description: >-
      Creditor communication group management for dynamic consumer targeting and
      campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Creditor EcoLetter campaign scheduling, quote, immediate send, and
      delivery queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Creditor campaign tracker reporting, refresh, and consumer export
      endpoints.
  - name: Consumer Profiles
    description: Creditor Consumer Profiles list, filter options, and CSV export endpoints.
  - name: Terms & Conditions
    description: Creditor-managed master and sub-account Terms & Conditions templates.
  - name: About Us & Contact
    description: Creditor-managed company About Us content shown to consumers.
  - name: Logo & Links
    description: >-
      Creditor-managed master and sub-account personalized logo colors, size,
      and consumer link metadata.
  - name: Users
    description: >-
      Master creditor user management, invitations, and account deletion
      endpoints.
paths:
  /communications/campaigns:
    get:
      tags:
        - Communications / Schedule Campaign
      summary: List campaigns
      description: >-
        List active creditor EcoLetter campaigns with search, sorting,
        sub-account scoping, and pagination.
      operationId: creditorListCampaigns
      parameters:
        - name: search
          in: query
          required: false
          description: Search campaign frequency, template name, or group name.
          schema:
            type: string
            maxLength: 255
        - name: sort
          in: query
          required: false
          description: >-
            Sort field. Snake-case values are preferred; kebab-case aliases are
            accepted for portal compatibility.
          schema:
            type: string
            default: start-date
            enum:
              - frequency
              - start_date
              - start-date
              - end_date
              - end-date
              - template_name
              - template-name
              - group_name
              - group-name
              - terms
              - time
        - $ref: '#/components/parameters/SortDirection'
        - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Campaigns returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/ActiveMembershipRequired'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    SortDirection:
      name: direction
      in: query
      required: false
      description: Sort direction.
      schema:
        type: string
        default: desc
        enum:
          - asc
          - desc
    PerPage:
      name: per_page
      in: query
      required: false
      description: Number of records per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  schemas:
    CampaignListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Campaign'
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
    Campaign:
      type: object
      required:
        - id
        - template_id
        - group_id
        - template
        - group
        - frequency
        - start_date
        - end_date
        - day_of_week
        - day_of_month
        - terms
        - is_run_immediately
      properties:
        id:
          type: integer
          example: 101
        template_id:
          type: integer
          example: 10
        group_id:
          type: integer
          example: 25
        template:
          oneOf:
            - $ref: '#/components/schemas/CampaignTemplateSummary'
            - type: 'null'
        group:
          oneOf:
            - $ref: '#/components/schemas/CampaignGroupSummary'
            - type: 'null'
        frequency:
          $ref: '#/components/schemas/CampaignFrequencySelection'
        start_date:
          type: string
          format: date
          nullable: true
          example: '2026-06-21'
        end_date:
          type: string
          format: date
          nullable: true
          example: '2026-09-21'
        day_of_week:
          type: integer
          nullable: true
          minimum: 0
          maximum: 6
          example: 1
        day_of_month:
          type: integer
          nullable: true
          minimum: 1
          maximum: 31
          example: 15
        terms:
          type: string
          example: Weekly on Monday
        is_run_immediately:
          type: boolean
          example: false
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    PaginationMeta:
      type: object
      additionalProperties: true
      properties:
        current_page:
          type: integer
        from:
          type: integer
          nullable: true
        last_page:
          type: integer
        path:
          type: string
        per_page:
          type: integer
        to:
          type: integer
          nullable: true
        total:
          type: integer
    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
    CampaignTemplateSummary:
      type: object
      required:
        - id
        - name
        - type
      properties:
        id:
          type: integer
          example: 10
        name:
          type: string
          example: Settlement EcoLetter
        type:
          $ref: '#/components/schemas/ELetterTemplateTypeSelection'
    CampaignGroupSummary:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          example: 25
        name:
          type: string
          example: Delivered January Group
    CampaignFrequencySelection:
      type: object
      required:
        - value
        - label
      properties:
        value:
          $ref: '#/components/schemas/CampaignFrequency'
        label:
          type: string
          example: Weekly
    ELetterTemplateTypeSelection:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: string
          enum:
            - e-letter
        label:
          type: string
          example: Eco Letter
    CampaignFrequency:
      type: string
      enum:
        - once
        - daily
        - weekly
        - monthly
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ActiveMembershipRequired:
      description: Authenticated creditor does not have an active membership.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: An active membership is required.
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````