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

# List withdrawals

> List your firm's withdrawals from the last 365 days, with optional filtering by payout month, account ID, or both.



## OpenAPI

````yaml /openapi.json get /api/withdrawals/
openapi: 3.0.3
info:
  title: TBBO API
  version: 1.0.0
  description: >
    Authentication uses short-lived session tokens (3 hours).


    Send the token with every request using the `Authorization` header:


    ```

    Authorization: Token <token>

    ```


    Example:


    ```

    Authorization: Token 123abc456def789

    ```


    To obtain a token, call `POST /auth/login/` with valid credentials. The
    response includes a `key` value. Use that value in the header above for
    subsequent API calls.


    How to find required IDs:


    - `challenge_id`: Prop Tech Configuration -> Challenges

    - `user_id`: Tickblaze Manager -> Users

    - `account_id`: Tickblaze Manager -> Accounts 
servers: []
security: []
tags:
  - name: withdrawals
    description: Withdrawal related endpoints
    x-displayName: Withdrawals
paths:
  /api/withdrawals/:
    get:
      tags:
        - withdrawals
      summary: List withdrawals
      description: >-
        List your firm's withdrawals from the last 365 days, with optional
        filtering by payout month, account ID, or both.
      operationId: api_withdrawals_retrieve
      parameters:
        - in: query
          name: account_id
          schema:
            type: integer
          description: Specific account ID to return withdrawals for.
        - in: query
          name: date_filter
          schema:
            type: string
            default: All
          description: Filter by month (ISO 8601 format) or "All"
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number
        - in: query
          name: page_size
          schema:
            type: integer
            default: 10
          description: Number of items per page
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicWithdrawalListResponse'
              examples:
                ListPayoutsExample:
                  value:
                    page: 1
                    page_size: 10
                    total_documents: 1
                    documents:
                      - email: use*@example.com
                        date: May 2026
                        withdrawable_amount: '10.00'
                        profit_split: '0.20'
                    average_payout: '10.00'
                  summary: List Payouts Example
          description: List of withdrawals
        '400':
          description: Invalid page, page size, account ID, or date filter.
      security:
        - tokenAuth: []
        - {}
components:
  schemas:
    PublicWithdrawalListResponse:
      type: object
      properties:
        page:
          type: integer
          description: Current 1-indexed page number.
        page_size:
          type: integer
          description: Number of withdrawals returned per page.
        total_documents:
          type: integer
          description: Total withdrawals matching the filters.
        documents:
          type: array
          items:
            $ref: '#/components/schemas/PublicWithdrawal'
          description: Withdrawals returned for the requested page.
        average_payout:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          description: >-
            Average requested withdrawable amount across withdrawals from the
            last 365 days, scoped by account ID when provided; the optional
            month filter does not change this value.
      required:
        - average_payout
        - documents
        - page
        - page_size
        - total_documents
    PublicWithdrawal:
      type: object
      properties:
        email:
          type: string
          readOnly: true
        date:
          type: string
          readOnly: true
        withdrawable_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,12}(?:\.\d{0,2})?$
          default: '0.00'
        profit_split:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          description: The fraction of available funds the user will receive.
      required:
        - date
        - email
        - profit_split
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.