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

# List knowledge proposals

> Returns proposals across the playbook, optionally filtered by status and
collection.



## OpenAPI

````yaml https://api.stuut.ai/openapi.json get /v2/aether/playbook/proposals
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/aether/playbook/proposals:
    get:
      tags:
        - aether
      summary: List knowledge proposals
      description: |-
        Returns proposals across the playbook, optionally filtered by status and
        collection.
      operationId: GetAetherPlaybookProposals
      parameters:
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/ProposalStatus'
              - type: 'null'
        - name: collection
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                enum:
                  - cash_application
                  - collections
                  - company
                  - credit_risk
                  - deductions
                  - disputes
                  - payments
                x-speakeasy-enum-format: union
              - type: 'null'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KnowledgeProposal'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ProposalStatus:
      type: string
      enum:
        - pending
        - approved
        - rejected
      title: ProposalStatus
    KnowledgeProposal:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Proposal ID
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When this proposal was created
        action:
          $ref: '#/components/schemas/ProposalAction'
          description: Create, revise, or archive
        article_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Article Id
          description: Target article
        content:
          anyOf:
            - type: string
            - type: 'null'
          title: Content
          description: Proposed article content
        customer_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Id
          description: Proposed customer scope
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Proposed article description
        collection:
          anyOf:
            - type: string
              enum:
                - cash_application
                - collections
                - company
                - credit_risk
                - deductions
                - disputes
                - payments
              x-speakeasy-enum-format: union
            - type: 'null'
          title: Collection
          description: Proposed collection
        extraction_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Extraction Id
          description: Extraction job that produced this
        knowledge_type:
          anyOf:
            - $ref: '#/components/schemas/KnowledgeType'
            - type: 'null'
          description: Proposed knowledge type
        review_notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Review Notes
          description: Reviewer's notes
        reviewed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Reviewed At
          description: When reviewed
        reviewed_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Reviewed By
          description: User who reviewed
        segment_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Segment Id
          description: Proposed segment scope
        source_excerpts:
          anyOf:
            - items:
                $ref: '#/components/schemas/SourceExcerpt'
              type: array
            - type: 'null'
          title: Source Excerpts
          description: Verbatim excerpts from the source
        stale:
          type: boolean
          title: Stale
          description: True when target article was modified after proposal creation
          default: false
        status:
          $ref: '#/components/schemas/ProposalStatus'
          description: Pending, approved, or rejected
        title:
          type: string
          title: Title
          description: Proposed article title
      additionalProperties: false
      type: object
      required:
        - id
        - created_at
        - action
        - status
        - title
      title: KnowledgeProposal
    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
    ProposalAction:
      type: string
      enum:
        - archive
        - create
        - revise
      title: ProposalAction
    KnowledgeType:
      type: string
      enum:
        - declarative
        - document
        - procedural
      title: KnowledgeType
    SourceExcerpt:
      properties:
        text:
          type: string
          title: Text
          description: Verbatim snippet from the source
        memory_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Memory Id
          description: Memory ID this excerpt came from, when sourced from memory
        page:
          anyOf:
            - type: integer
            - type: 'null'
          title: Page
          description: Page number in the source document
      type: object
      required:
        - text
      title: SourceExcerpt
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````