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

# Export users CSV

> Exports every user matching the same filters, search, sorting, permissions, and firm scope used by the users list. The CSV mirrors the users-list response fields except user-deduplication duplicate-group details.



## OpenAPI

````yaml /openapi.json get /api/users/export/
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/users/export/:
    get:
      tags:
        - Users
      summary: Export users CSV
      description: >-
        Exports every user matching the same filters, search, sorting,
        permissions, and firm scope used by the users list. The CSV mirrors the
        users-list response fields except user-deduplication duplicate-group
        details.
      operationId: api_users_export_retrieve
      parameters:
        - in: query
          name: email
          schema:
            type: string
          description: Case-insensitive exact match on user email.
        - in: query
          name: order_by
          schema:
            type: string
          description: >-
            Sort by allowed fields only: `created`, `email`, `full_name`,
            `prop_firm__slug`, `user_type`. Supports single (`order_by=email`),
            descending (`order_by=-created`), and multi-column
            (`order_by=email,-created`).
        - in: query
          name: prop_firm_id
          schema:
            type: string
          description: Comma-separated firm IDs where the user has an active membership.
        - in: query
          name: prop_firm_slug
          schema:
            type: string
          description: Comma-separated firm slugs where the user has an active membership.
        - in: query
          name: search
          schema:
            type: string
          description: >-
            Case-insensitive partial match across user `id`, `email`, and
            `full_name`.
        - in: query
          name: user_type
          schema:
            type: string
          description: >-
            Filter by self-cert classification. Supported values: `pro`,
            `non_pro`.
      responses:
        '200':
          description: CSV file with exported users.
      security:
        - tokenAuth: []
components:
  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.