> ## Documentation Index
> Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Partners

> List Partners

Retrieve a list of partners with invoice stats and outreach state.



## OpenAPI

````yaml https://api.stuut.ai/openapi.json get /v2/partners
openapi: 3.1.0
info:
  title: Stuut API
  termsOfService: https://stuut.ai/terms-and-conditions
  contact:
    name: Stuut Support
    url: https://stuut.ai/
    email: devs@stuut.co
  version: 2.0.0
servers: []
security:
  - HTTPBearer: []
tags:
  - name: adjustments
    description: Operations for managing payment adjustments (fees, discounts, write-offs).
    x-displayName: Adjustments
  - name: aether
    description: Operations for aether.
    x-displayName: Aether
  - name: analytics
    description: Operations for retrieving analytics and dashboard data.
    x-displayName: Analytics
  - name: assistant
    description: Operations for the in-app chat assistant.
    x-displayName: Assistant
  - name: audit-log
    description: Operations for retrieving the organization's audit log.
    x-displayName: Audit Log
  - name: bank-accounts
    description: Operations for retrieving and managing bank accounts.
    x-displayName: Bank Accounts
  - name: bank-statements
    description: Operations for retrieving and managing bank statements.
    x-displayName: Bank Statements
  - name: bank-transactions
    description: Operations for retrieving and managing bank transactions.
    x-displayName: Bank Transactions
  - name: business-units
    description: Operations for listing and managing business units.
    x-displayName: Business Units
  - name: call-agent
    description: >-
      Operations for initiating and managing real-time voice calls with
      partners.
    x-displayName: Call Agent
  - name: calls
    description: Operations for retrieving and managing voice call records.
    x-displayName: Calls
  - name: cash-app
    description: Operations for cash application — matching incoming payments to invoices.
    x-displayName: Cash Application
  - name: chats
    description: Operations for managing chat conversations.
    x-displayName: Chats
  - name: cnam-registration
    description: Operations for managing CNAM (caller ID name) registration.
    x-displayName: CNAM Registration
  - name: credit-memos
    description: Operations for retrieving and searching credit memos.
    x-displayName: Credit Memos
  - name: custom-table-templates
    description: >-
      Operations for managing custom table templates used in email template
      variables.
    x-displayName: Custom Table Templates
  - name: customer-segments
    description: Operations for managing customer segments.
    x-displayName: Customer Segments
  - name: deductions-knowledge
    description: Operations for managing deduction processing knowledge entries.
    x-displayName: Deductions Knowledge
  - name: email-threads
    description: Operations for managing email threads.
    x-displayName: Email Threads
  - name: emails
    description: Operations for retrieving and managing emails.
    x-displayName: Emails
  - name: exports
    description: Operations for requesting and retrieving async data exports.
    x-displayName: Exports
  - name: integrations
    description: >-
      Operations for managing integrations with external systems (e.g. ERP, CRM,
      etc.).
    x-displayName: Integrations
  - name: internal-contacts
    description: >-
      Operations for managing internal contacts (CSMs, account managers, etc.)
      and their assignments to partners.
    x-displayName: Internal Contacts
  - name: invoices
    description: Operations for retrieving and managing invoices.
    x-displayName: Invoices
  - name: kyb
    description: Operations for Know Your Business (KYB) verification.
    x-displayName: KYB
  - name: ledger-accounts
    description: Operations for retrieving and managing ledger accounts.
    x-displayName: Ledger Accounts
  - name: mailbox-settings
    description: >-
      Operations for an organization's mailbox provider configuration: Microsoft
      admin consent, shared-mailbox discovery, and provider health.
    x-displayName: Mailbox Settings
  - name: mailboxes
    description: >-
      Operations for connecting, listing, updating, and archiving user and
      shared mailboxes, including delegated OAuth sign-in.
    x-displayName: Mailboxes
  - name: media
    description: >-
      Operations for signing direct-to-storage media uploads (e.g. signature
      images).
    x-displayName: Media
  - name: organizations
    description: Operations for retrieving and managing the current organization.
    x-displayName: Organizations
  - name: outreach-workflows
    description: Operations for managing automated collections outreach workflows.
    x-displayName: Outreach Workflows
  - name: partners
    description: Operations for retrieving and managing customers.
    x-displayName: Partners
  - name: payments
    description: Operations for approving and managing payments.
    x-displayName: Payments
  - name: report-configs
    description: >-
      Operations for managing report configurations (frequency, recipients,
      schedule).
    x-displayName: Report Configs
  - name: sms-campaign-registration
    description: Operations for managing A2P 10DLC SMS campaign registration.
    x-displayName: SMS Campaign Registration
  - name: sms-templates
    description: >-
      Operations for defining, storing, and managing parameterized SMS message
      templates.
    x-displayName: SMS Templates
  - name: sms-threads
    description: Operations for retrieving and managing SMS conversation threads.
    x-displayName: SMS Threads
  - name: users
    description: Operations for retrieving and managing users.
    x-displayName: Users
  - name: users-ooo
    description: Operations for managing user out-of-office (OOO) status and coverage.
    x-displayName: Users OOO
paths:
  /v2/partners:
    get:
      tags:
        - partners
      summary: Get Partners
      description: |-
        List Partners

        Retrieve a list of partners with invoice stats and outreach state.
      operationId: GetPartners
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Page number, 0 indexed.
            default: 0
          description: Page number, 0 indexed.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Number of records per page.
            default: 100
          description: Number of records per page.
        - name: sort_by
          in: query
          required: false
          schema:
            enum:
              - currency
              - email
              - is_overdue
              - num_open_invoices
              - name
              - oldest_open_invoice_due_date
              - phone
              - invoice_balance
              - total_overdue
              - last_outreach_at
              - account_number
              - remote_id
            type: string
            x-speakeasy-enum-format: union
            default: total_overdue
        - name: sort_order
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
            default: desc
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: delimited_search
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - name: group_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
        - name: with_overdue_invoices
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
        - name: has_outreach
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
        - name: outreach_paused
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
        - name: segment_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by customer segment ID.
          description: Filter by customer segment ID.
        - name: segment_exclusive
          in: query
          required: false
          schema:
            type: boolean
            description: Exclude partners matching higher-priority segments.
            default: true
          description: Exclude partners matching higher-priority segments.
        - name: business_unit_id__in
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by business unit IDs
          description: Filter by business unit IDs
        - name: assignee_id__in
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
        - name: assignee_id__nin
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
        - name: billing_address__country__in
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
        - name: dunning_state_id__in
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
        - name: dunning_state_id__nin
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
        - name: invoice_balance__gte
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
        - name: invoice_balance__lte
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
        - name: num_open_invoices__gte
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
        - name: num_open_invoices__lte
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
        - name: missing_information__in
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  enum:
                    - primary_email
                    - primary_phone
                    - assignee
                    - assignee_email_linked
                    - disabled_email
                    - disabled_phone
                  type: string
                  x-speakeasy-enum-format: union
              - type: 'null'
        - name: missing_information__nin
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  enum:
                    - primary_email
                    - primary_phone
                    - assignee
                    - assignee_email_linked
                    - disabled_email
                    - disabled_phone
                  type: string
                  x-speakeasy-enum-format: union
              - type: 'null'
        - name: missing_information__eq
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  enum:
                    - primary_email
                    - primary_phone
                    - assignee
                    - assignee_email_linked
                    - disabled_email
                    - disabled_phone
                  type: string
                  x-speakeasy-enum-format: union
              - type: 'null'
        - name: missing_information__ne
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  enum:
                    - primary_email
                    - primary_phone
                    - assignee
                    - assignee_email_linked
                    - disabled_email
                    - disabled_phone
                  type: string
                  x-speakeasy-enum-format: union
              - type: 'null'
        - name: custom_fields
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_PartnerListSummary_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    PaginatedResponse_PartnerListSummary_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PartnerListSummary'
          type: array
          title: ''
          description: The list of records.
        current_page:
          type: integer
          title: ''
          description: The current page.
          default: 0
        total_records:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: ''
          description: Total number of records.
        next_page:
          anyOf:
            - type: integer
            - type: 'null'
          title: ''
          description: The next page number, if one exists.
      type: object
      required:
        - data
        - current_page
        - total_records
        - next_page
      title: PaginatedResponse[PartnerListSummary]
    HTTPValidationError:
      $defs:
        ValidationError:
          properties:
            loc:
              items:
                anyOf:
                  - type: string
                  - type: integer
              title: Location
              type: array
            msg:
              title: Message
              type: string
            type:
              title: Type
              type: string
          required:
            - loc
            - msg
            - type
          title: ValidationError
          type: object
          x-speakeasy-include: true
      properties:
        type:
          const: request-validation
          title: Type
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Human-readable description of this specific problem.
          title: Detail
          x-speakeasy-error-message: true
        status:
          const: 422
          title: Status
          type: integer
        title:
          description: Short human-readable summary of the problem.
          title: Title
          type: string
          x-speakeasy-error-message: true
        errors:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Errors
          type: array
      required:
        - type
        - status
        - title
        - errors
      title: APIError
      type: object
    PartnerListSummary:
      properties:
        created_at:
          $ref: '#/components/schemas/UTCDateTime'
          title: ''
        modified_at:
          anyOf:
            - $ref: '#/components/schemas/UTCDateTime'
            - type: 'null'
          title: ''
        id:
          type: string
          title: ''
        account_number:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The customer's account number.
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The ID of the user assigned to this partner, if any.
        business_unit_id:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The business unit this partner belongs to.
        currency:
          anyOf:
            - $ref: '#/components/schemas/Currency'
            - type: 'null'
          title: ''
          description: The partner's default currency code (e.g. USD).
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The partner's company email address.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The full name of the partner.
        legal_name:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: The legal name of this partner, typically applies to businesses.
        phone:
          anyOf:
            - type: string
              format: phone
              description: >-
                A phone number in [E.164](https://en.wikipedia.org/wiki/E.164)
                format
            - type: 'null'
          title: ''
          description: The partner's default phone number.
        parent_id:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
        remote_id:
          type: string
          title: ''
          description: The partner's third party id.
        subsidiary_count:
          type: integer
          minimum: 0
          title: ''
        last_outreach_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: ''
          description: The last date outreach was sent for this partner.
        last_outreach_to:
          anyOf:
            - type: string
            - type: 'null'
          title: ''
          description: >-
            The last recipient of outreach that was sent for this partner (email
            address or phone number).
        last_outreach_channel:
          anyOf:
            - $ref: '#/components/schemas/OutreachActionType'
            - type: 'null'
          title: ''
          description: >-
            The last channel outreach was sent in for this partner (phone or
            email).
        is_email_outreach_manually_paused:
          type: boolean
          title: ''
        is_call_outreach_manually_paused:
          type: boolean
          title: ''
        invoice_stats:
          $ref: '#/components/schemas/PartnerInvoiceStats'
          title: ''
        contact_completeness:
          $ref: '#/components/schemas/ContactCompleteness'
          title: ''
        active_dispute_count:
          type: integer
          minimum: 0
          title: ''
          default: 0
        terminal_dispute_count:
          type: integer
          minimum: 0
          title: ''
          default: 0
        object:
          type: string
          title: ''
          description: >-
            String representing the object's type. Objects of the same type
            share the same value.
          readOnly: true
      type: object
      required:
        - created_at
        - modified_at
        - id
        - account_number
        - assignee_id
        - business_unit_id
        - currency
        - email
        - name
        - legal_name
        - phone
        - parent_id
        - remote_id
        - subsidiary_count
        - last_outreach_at
        - last_outreach_to
        - last_outreach_channel
        - is_email_outreach_manually_paused
        - is_call_outreach_manually_paused
        - invoice_stats
        - contact_completeness
        - active_dispute_count
        - terminal_dispute_count
        - object
      title: PartnerListSummary
      description: |-
        Used for showing the partner table view on the frontend.
        Includes a bunch of joined/analytical data beyond a basic summary.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          type: string
          title: Type
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
      x-speakeasy-include: true
    UTCDateTime:
      type: string
      format: date-time
    Currency:
      type: string
      enum:
        - ADP
        - AED
        - AFA
        - AFN
        - ALK
        - ALL
        - AMD
        - ANG
        - AOA
        - AOK
        - AON
        - AOR
        - ARA
        - ARL
        - ARM
        - ARP
        - ARS
        - ATS
        - AUD
        - AWG
        - AZM
        - AZN
        - BAD
        - BAM
        - BAN
        - BBD
        - BDT
        - BEC
        - BEF
        - BEL
        - BGL
        - BGM
        - BGN
        - BGO
        - BHD
        - BIF
        - BMD
        - BND
        - BOB
        - BOL
        - BOP
        - BOV
        - BRB
        - BRC
        - BRE
        - BRL
        - BRN
        - BRR
        - BRZ
        - BSD
        - BTN
        - BUK
        - BWP
        - BYB
        - BYN
        - BYR
        - BZD
        - CAD
        - CDF
        - CHE
        - CHF
        - CHW
        - CLE
        - CLF
        - CLP
        - CNH
        - CNX
        - CNY
        - COP
        - COU
        - CRC
        - CSD
        - CSK
        - CUC
        - CUP
        - CVE
        - CYP
        - CZK
        - DDM
        - DEM
        - DJF
        - DKK
        - DOP
        - DZD
        - ECS
        - ECV
        - EEK
        - EGP
        - ERN
        - ESA
        - ESB
        - ESP
        - ETB
        - EUR
        - FIM
        - FJD
        - FKP
        - FRF
        - GBP
        - GEK
        - GEL
        - GHC
        - GHS
        - GIP
        - GMD
        - GNF
        - GNS
        - GQE
        - GRD
        - GTQ
        - GWE
        - GWP
        - GYD
        - HKD
        - HNL
        - HRD
        - HRK
        - HTG
        - HUF
        - IDR
        - IEP
        - ILP
        - ILR
        - ILS
        - INR
        - IQD
        - IRR
        - ISJ
        - ISK
        - ITL
        - JMD
        - JOD
        - JPY
        - KES
        - KGS
        - KHR
        - KMF
        - KPW
        - KRH
        - KRO
        - KRW
        - KWD
        - KYD
        - KZT
        - LAK
        - LBP
        - LKR
        - LRD
        - LSL
        - LTL
        - LTT
        - LUC
        - LUF
        - LUL
        - LVL
        - LVR
        - LYD
        - MAD
        - MAF
        - MCF
        - MDC
        - MDL
        - MGA
        - MGF
        - MKD
        - MKN
        - MLF
        - MMK
        - MNT
        - MOP
        - MRO
        - MRU
        - MTL
        - MTP
        - MUR
        - MVP
        - MVR
        - MWK
        - MXN
        - MXP
        - MXV
        - MYR
        - MZE
        - MZM
        - MZN
        - NAD
        - NGN
        - NIC
        - NIO
        - NLG
        - NOK
        - NPR
        - NZD
        - OMR
        - PAB
        - PEI
        - PEN
        - PES
        - PGK
        - PHP
        - PKR
        - PLN
        - PLZ
        - PTE
        - PYG
        - QAR
        - RHD
        - ROL
        - RON
        - RSD
        - RUB
        - RUR
        - RWF
        - SAR
        - SBD
        - SCR
        - SDD
        - SDG
        - SDP
        - SEK
        - SGD
        - SHP
        - SIT
        - SKK
        - SLE
        - SLL
        - SOS
        - SRD
        - SRG
        - SSP
        - STD
        - STN
        - SUR
        - SVC
        - SYP
        - SZL
        - THB
        - TJR
        - TJS
        - TMM
        - TMT
        - TND
        - TOP
        - TPE
        - TRL
        - TRY
        - TTD
        - TWD
        - TZS
        - UAH
        - UAK
        - UGS
        - UGX
        - USD
        - USN
        - USS
        - UYI
        - UYP
        - UYU
        - UYW
        - UZS
        - VEB
        - VED
        - VEF
        - VES
        - VND
        - VNN
        - VUV
        - WST
        - XAF
        - XAG
        - XAU
        - XBA
        - XBB
        - XBC
        - XBD
        - XCD
        - XCG
        - XDR
        - XEU
        - XFO
        - XFU
        - XOF
        - XPD
        - XPF
        - XPT
        - XRE
        - XSU
        - XTS
        - XUA
        - XXX
        - YDD
        - YER
        - YUD
        - YUM
        - YUN
        - YUR
        - ZAL
        - ZAR
        - ZMK
        - ZMW
        - ZRN
        - ZRZ
        - ZWD
        - ZWL
        - ZWR
      description: >-
        The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
        currency code.
      x-speakeasy-enum-format: union
    OutreachActionType:
      type: string
      enum:
        - email
        - call
        - sms
      title: OutreachActionType
    PartnerInvoiceStats:
      properties:
        invoice_balance:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          format: decimal
          title: Invoice Balance
        total_overdue:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          format: decimal
          title: Total Overdue
        num_overdue_invoices:
          type: integer
          minimum: 0
          title: Num Overdue Invoices
        num_open_invoices:
          type: integer
          minimum: 0
          title: Num Open Invoices
        oldest_open_invoice_due_date:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Oldest Open Invoice Due Date
      type: object
      required:
        - invoice_balance
        - total_overdue
        - num_overdue_invoices
        - num_open_invoices
        - oldest_open_invoice_due_date
      title: PartnerInvoiceStats
    ContactCompleteness:
      properties:
        has_primary_email:
          type: boolean
          title: Has Primary Email
        has_primary_phone:
          type: boolean
          title: Has Primary Phone
        is_email_disabled:
          type: boolean
          title: Is Email Disabled
        is_phone_disabled:
          type: boolean
          title: Is Phone Disabled
        is_sms_disabled:
          type: boolean
          title: Is Sms Disabled
      type: object
      required:
        - has_primary_email
        - has_primary_phone
        - is_email_disabled
        - is_phone_disabled
        - is_sms_disabled
      title: ContactCompleteness
      description: Contact information completeness for partner table UI.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````