> ## 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 reseller partners

> List reseller partners with visible table metrics, row actions, pagination, and the current 60-day report history metadata.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /manage-partners
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:
  /manage-partners:
    get:
      tags:
        - Reseller Partners
      summary: List reseller partners
      description: >-
        List reseller partners with visible table metrics, row actions,
        pagination, and the current 60-day report history metadata.
      operationId: superadminListResellerPartners
      parameters:
        - name: search
          in: query
          required: false
          description: >-
            Search by partner name, contact name, contact email, contact phone,
            or report email.
          schema:
            type: string
            maxLength: 255
        - name: sort
          in: query
          required: false
          description: Sort field matching the visible reseller partner table columns.
          schema:
            type: string
            enum:
              - company-name
              - contact-name
              - contact-email
              - contact-phone
              - revenue-share
              - creditors-quota
              - joined
              - hosting-charges
              - percentage-of-payments
              - creditor-eco-letters
              - yn-total-revenue
              - partner-payout
            default: company-name
        - name: direction
          in: query
          required: false
          description: Sort direction.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
        - name: per_page
          in: query
          required: false
          description: Number of partners per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Reseller partners returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperadminPartnerListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    SuperadminPartnerListResponse:
      type: object
      required:
        - data
        - pagination
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SuperadminPartner'
        pagination:
          $ref: '#/components/schemas/Pagination'
        meta:
          type: object
          additionalProperties: false
          required:
            - report_histories
          properties:
            report_histories:
              type: array
              description: >-
                Current 60-day reseller partner report history rows shown below
                the partner table.
              items:
                $ref: '#/components/schemas/PartnerReportHistory'
    SuperadminPartner:
      type: object
      additionalProperties: false
      required:
        - id
        - name
        - contact
        - report_emails
        - contact_and_report_emails
        - revenue_share
        - revenue_share_label
        - creditors_quota
        - creditors_quota_label
        - active_members_count
        - active_members_count_label
        - quota_percentage
        - quota_percentage_label
        - hosting_charges
        - hosting_charges_label
        - percentage_of_payments
        - percentage_of_payments_label
        - creditor_eco_letters
        - creditor_eco_letters_label
        - yn_total_revenue
        - yn_total_revenue_label
        - partner_payout
        - partner_payout_label
        - partnership_link
        - actions
        - action_items
        - created_at
        - updated_at
      properties:
        id:
          type: integer
          example: 12
        name:
          type: string
          example: Acme Partners
        contact:
          type: object
          additionalProperties: false
          required:
            - first_name
            - last_name
            - name
            - email
            - phone
            - phone_label
          properties:
            first_name:
              type: string
              example: Alice
            last_name:
              type: string
              nullable: true
              example: Smith
            name:
              type: string
              example: Alice Smith
            email:
              type: string
              format: email
              example: alice@partner.test
            phone:
              type: string
              example: '9005090050'
            phone_label:
              type: string
              example: (900) 509-0050
        report_emails:
          type: array
          items:
            type: string
            format: email
          example:
            - reports@partner.test
        contact_and_report_emails:
          type: array
          description: >-
            Unique contact email followed by report emails for the
            Contact|Report Email table column.
          items:
            type: string
            format: email
          example:
            - alice@partner.test
            - reports@partner.test
        revenue_share:
          type: string
          example: '10.00'
        revenue_share_label:
          type: string
          example: 10.00%
        creditors_quota:
          type: integer
          example: 50000
        creditors_quota_label:
          type: string
          example: 50,000
        active_members_count:
          type: integer
          example: 25
        active_members_count_label:
          type: string
          example: '25'
        quota_percentage:
          type: number
          format: float
          example: 0.05
        quota_percentage_label:
          type: string
          example: 0.05%
        hosting_charges:
          type: number
          format: float
          example: 100
        hosting_charges_label:
          type: string
          example: $100.00
        percentage_of_payments:
          type: number
          format: float
          example: 50
        percentage_of_payments_label:
          type: string
          example: $50.00
        creditor_eco_letters:
          type: number
          format: float
          example: 20
        creditor_eco_letters_label:
          type: string
          example: $20.00
        yn_total_revenue:
          type: number
          format: float
          example: 170
        yn_total_revenue_label:
          type: string
          example: $170.00
        partner_payout:
          type: number
          format: float
          example: 17
        partner_payout_label:
          type: string
          example: $17.00
        partnership_link:
          type: string
          format: uri
          nullable: true
          example: https://creditor.younegotiate.com/register?code=PARTNER123
        actions:
          type: object
          additionalProperties: false
          required:
            - can_copy_partnership_link
            - can_download_mtd_rev_share_report
            - can_export_members
            - can_edit
          properties:
            can_copy_partnership_link:
              type: boolean
            can_download_mtd_rev_share_report:
              type: boolean
            can_export_members:
              type: boolean
            can_edit:
              type: boolean
        action_items:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - label
              - available
            properties:
              key:
                type: string
                enum:
                  - copy_partnership_link
                  - download_mtd_rev_share_report
                  - export_members
                  - edit
              label:
                type: string
              available:
                type: boolean
        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
    PartnerReportHistory:
      type: object
      additionalProperties: false
      required:
        - id
        - partner_id
        - partner
        - sent_on
        - period_label
        - report_emails
        - total_revenue
        - total_revenue_label
        - partner_payout
        - partner_payout_label
        - has_file
        - actions
        - action_items
      properties:
        id:
          type: integer
          example: 301
        partner_id:
          type: integer
          example: 12
        partner:
          type: object
          additionalProperties: false
          required:
            - id
            - name
          properties:
            id:
              type: integer
              example: 12
            name:
              type: string
              example: Acme Partners
        sent_on:
          type: string
          format: date-time
          nullable: true
        period_label:
          type: string
          example: May 2026
        report_emails:
          type: array
          items:
            type: string
            format: email
          example:
            - reports@partner.test
        total_revenue:
          type: number
          format: float
          example: 170
        total_revenue_label:
          type: string
          example: $170.00
        partner_payout:
          type: number
          format: float
          example: 17
        partner_payout_label:
          type: string
          example: $17.00
        has_file:
          type: boolean
          example: true
        actions:
          type: object
          additionalProperties: false
          required:
            - can_download
          properties:
            can_download:
              type: boolean
        action_items:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - key
              - label
              - available
            properties:
              key:
                type: string
                enum:
                  - download
                  - summary_only
              label:
                type: string
              available:
                type: boolean
    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

````