> ## 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 entitlement flags by user

> Returns a paginated per-user entitlement snapshot. Each user item includes every entitlement key; `true` means the user has at least one authorized entitlement that enables trading for that entitlement.



## OpenAPI

````yaml /openapi.json get /api/users/entitlements/
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/entitlements/:
    get:
      tags:
        - Users
      summary: List entitlement flags by user
      description: >-
        Returns a paginated per-user entitlement snapshot. Each user item
        includes every entitlement key; `true` means the user has at least one
        authorized entitlement that enables trading for that entitlement.
      operationId: api_users_entitlements_retrieve
      parameters:
        - in: query
          name: order_by
          schema:
            type: string
          description: >-
            Sort by allowed fields only: `created`, `email`, `full_name`.
            Supports single (`order_by=email`), descending
            (`order_by=-created`), and multi-column (`order_by=email,-created`).
        - in: query
          name: search
          schema:
            type: string
          description: >-
            Case-insensitive partial match across user `id`, `email`, and
            `full_name`.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUserVenueTradingFlagList'
          description: ''
      security:
        - tokenAuth: []
components:
  schemas:
    PaginatedUserVenueTradingFlagList:
      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/UserVenueTradingFlag'
    UserVenueTradingFlag:
      type: object
      description: |-
        Render a per-user venue snapshot.

        The row resolves one representative Prop Firm so downstream systems can
        identify the tenant without receiving the full firm payload.
      properties:
        id:
          type: integer
          readOnly: true
        email:
          type: string
          format: email
          maxLength: 200
        prop_firm_id:
          type: string
          readOnly: true
        prop_firm_slug:
          type: string
          readOnly: true
        entitlements:
          type: string
          readOnly: true
      required:
        - email
        - entitlements
        - id
        - prop_firm_id
        - prop_firm_slug
  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.