> ## 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 users > Returns paginated users for your firm, including account counts. ## OpenAPI ````yaml /openapi.json get /api/users/ 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 ``` 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/: get: tags: - Users summary: List users description: Returns paginated users for your firm, including account counts. operationId: api_users_list parameters: - in: query name: address_1 schema: type: string - in: query name: address_2 schema: type: string - in: query name: affiliate_id schema: type: string format: uuid - in: query name: blocked schema: type: boolean - in: query name: city schema: type: string - in: query name: country_code schema: type: string - in: query name: created schema: type: string format: date-time - in: query name: customer_type schema: type: string default: non_pro enum: - non_pro - pro description: |- * `pro` - Professional * `non_pro` - Non-Professional - in: query name: deactivated_at schema: type: string format: date-time - in: query name: deactivation_reason schema: type: string - in: query name: deleted_at schema: type: string format: date-time - in: query name: email schema: type: string description: Case-insensitive exact match on user email. - in: query name: firm_groups schema: type: array items: type: integer explode: true style: form - in: query name: full_name schema: type: string - in: query name: group_uuid schema: type: string format: uuid - in: query name: groups schema: type: array items: type: integer explode: true style: form - in: query name: ip_addresses schema: type: string - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - in: query name: is_superuser schema: type: boolean - in: query name: kyc_completed schema: type: boolean - in: query name: kyc_url schema: type: string - in: query name: last_login schema: type: string format: date-time - in: query name: legacy_password_hash schema: type: string - in: query name: legacy_password_salt schema: type: string - in: query name: modified schema: type: string format: date-time - in: query name: notes schema: type: string - 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`). - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: password schema: type: string - in: query name: phone schema: type: string - in: query name: postcode schema: type: string - in: query name: prop_firm schema: type: string format: uuid - 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: referral_id schema: type: string - in: query name: reward_points schema: type: integer - in: query name: search schema: type: string description: >- Case-insensitive partial match across user `id`, `email`, and `full_name`. - in: query name: state schema: type: string - in: query name: user_permissions schema: type: array items: type: integer explode: true style: form - in: query name: user_type schema: type: string description: >- Filter by self-cert classification. Supported values: `pro`, `non_pro`. responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserTickblazeManagerList' examples: UserResponse: value: meta: count: 123 page: 1 page_size: 20 total_pages: 7 has_next: true has_previous: false next: https://api.example.org/resources/?page=2 previous: null results: - id: 123 email: jane.doe@example.com full_name: Jane Doe ip_addresses: - 203.0.113.42 - 198.51.100.17 country_code: US state: CA postcode: '94105' kyc_verified: verified city: San Francisco address_1: 123 Market Street address_2: Suite 500 phone: +1-415-555-0199 blocked: false prop_firm: prop_firm_id: 507ede8b-951d-4c38-877a-f242463ce14f prop_firm_name: Example Firm prop_firm_slug: example-firm account_count: 42 created_at: '2021-06-18T10:42:15Z' contact_email: support@example.com user_type: pro total_accounts_purchased: 12 total_active_accounts: 8 total_failed_accounts: 4 duplicate_group: count: 2 emails: - jane.doe@example.com - jane.alt@example.com csv: jane.doe@example.com,jane.alt@example.com trading_status: enabled entitlements: - name: CME Market Data data_level: l1 exchanges: - cbot - nymex status: AUTHORIZED authorized_at: '2026-03-20T09:15:00Z' summary: User response description: '' security: - tokenAuth: [] components: schemas: PaginatedUserTickblazeManagerList: type: object required: - meta - results properties: meta: type: object required: - count - page - page_size - total_pages - has_next - has_previous - next - previous description: >- Pagination metadata. Use `has_next`/`has_previous` for boolean page checks and `next`/`previous` for page URLs. example: count: 123 page: 1 page_size: 20 total_pages: 7 has_next: true has_previous: false next: https://api.example.org/resources/?page=2 previous: null properties: count: type: integer example: 123 description: Total number of items matching the request. page: type: integer example: 1 description: Current 1-indexed page number. page_size: type: integer example: 20 description: Number of items returned per page. total_pages: type: integer example: 7 description: Total number of pages available. has_next: type: boolean example: true description: Whether another page is available after this one. has_previous: type: boolean example: false description: Whether a page is available before this one. next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 description: URL for the next page, or null on the final page. previous: type: string nullable: true format: uri example: null description: URL for the previous page, or null on the first page. results: type: array items: $ref: '#/components/schemas/UserTickblazeManager' UserTickblazeManager: type: object description: |- Serializer used by the Tickblaze Manager. Exposes user fields relevant to account oversight. properties: id: type: integer readOnly: true email: type: string format: email readOnly: true full_name: type: string maxLength: 100 ip_addresses: type: array items: type: string country_code: type: string nullable: true maxLength: 100 state: type: string nullable: true maxLength: 100 postcode: type: string nullable: true maxLength: 100 kyc_verified: type: string readOnly: true city: type: string nullable: true maxLength: 100 address_1: type: string nullable: true maxLength: 500 address_2: type: string nullable: true maxLength: 500 phone: type: string nullable: true maxLength: 100 blocked: type: string readOnly: true created: type: string format: date-time readOnly: true prop_firm: type: string readOnly: true user_type: type: string readOnly: true description: >- Self-cert classification: `pro` when the pro declaration is accepted, otherwise `non pro`. total_accounts_purchased: type: integer readOnly: true total_active_accounts: type: integer readOnly: true total_failed_accounts: type: integer readOnly: true duplicate_group: type: string readOnly: true trading_status: type: string readOnly: true entitlements: type: string readOnly: true description: Entitlements for the user. required: - blocked - created - duplicate_group - email - entitlements - full_name - id - kyc_verified - prop_firm - total_accounts_purchased - total_active_accounts - total_failed_accounts - trading_status - user_type 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.