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

# List workspace payments with source attribution

> Returns the normalized workspace payment ledger used by the dashboard.
Support App payments and verified Commerce orders are available now.
Paid booking reservations use the Commerce order adapter after online
booking collection has created a verified paid order.




## OpenAPI

````yaml /openapi.yaml get /workspaces/{workspace}/payments
openapi: 3.1.0
info:
  title: Contact Button API
  version: 1.0.0-alpha.1
  description: >
    API-first management and public agent actions for Contact Buttons and
    button.contact pages.

    API v1 is the first public contract. Existing private legacy API and browser
    workflows remain supported.
  contact:
    name: Contact Button
    url: https://learn.contactbutton.com
servers:
  - url: https://api.contactbutton.com/v1
    description: Production (canonical)
  - url: https://app.contactbutton.com/v1
    description: Backwards-compatible application-domain alias
security:
  - bearerAuth: []
tags:
  - name: Onboarding
    description: Human-verified agent onboarding.
  - name: Workspaces
  - name: Team
  - name: Pages
  - name: Agents
    description: Workspace Agent profile and behavior configuration.
  - name: Domains
  - name: Buttons
  - name: Forms
  - name: Surveys
  - name: Apps
  - name: Knowledge
  - name: Booking
  - name: Telephony
    description: >-
      Bring-your-own-Telnyx setup, call flows, phone numbers, and voice
      interactions.
  - name: Reviews
    description: >-
      Send consented review requests through workspace-owned email, SMS, and
      WhatsApp channels.
  - name: Commerce
  - name: Conversations
    description: >-
      Contact-centric threads and messages across chat, email, WhatsApp, and
      forms.
  - name: Engagement inbox
  - name: Public actions
    description: Public, rate-limited actions that may require human confirmation.
paths:
  /workspaces/{workspace}/payments:
    get:
      tags:
        - Commerce
      summary: List workspace payments with source attribution
      description: |
        Returns the normalized workspace payment ledger used by the dashboard.
        Support App payments and verified Commerce orders are available now.
        Paid booking reservations use the Commerce order adapter after online
        booking collection has created a verified paid order.
      operationId: listWorkspacePayments
      parameters:
        - $ref: '#/components/parameters/WorkspaceId'
      responses:
        '200':
          description: Workspace-scoped payments and aggregate summary.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkspacePayment'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      summary:
                        type: object
                      sources:
                        type: object
components:
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    WorkspacePayment:
      type: object
      required:
        - id
        - source
        - source_label
        - source_name
        - customer_name
        - status
        - amount_minor
        - currency
        - created_at
      properties:
        id:
          type: string
          format: uuid
        source:
          type: string
          enum:
            - support
            - commerce
            - booking
        source_label:
          type: string
        source_name:
          type: string
        customer_name:
          type: string
        status:
          type: string
        amount_minor:
          type: integer
        currency:
          type: string
          minLength: 3
          maxLength: 3
        application_fee_minor:
          type:
            - integer
            - 'null'
        stripe_fee_minor:
          type:
            - integer
            - 'null'
        creator_net_minor:
          type:
            - integer
            - 'null'
        created_at:
          type: string
          format: date-time
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum personal access token or OAuth 2.0 access token
      description: >
        A Contact Button scoped bearer key. Send `Authorization: Bearer
        <token>`.

        Token abilities are enforced independently of workspace membership; both
        checks must pass.

        Interactive MCP clients use registered OAuth applications, Authorization
        Code + PKCE,

        audience-bound tokens, and explicit workspace grants. Personal Sanctum
        tokens remain supported.
      x-contact-button-token-abilities:
        workspaces:read: Read workspaces, teams, domains, settings, and connections.
        workspaces:write: >-
          Create and manage workspaces, teams, domains, settings, and
          connections.
        content:read: Read buttons, forms, lists, pages, booking types, and knowledge.
        content:write: Create, update, publish, and remove content.
        engagements:read: >-
          Read submissions, subscribers, bookings, callbacks, calls, reviews,
          and conversations.
        engagements:manage: Reply to and manage engagement records.
        actions:request: Request protected actions that can still require human confirmation.

````