> ## 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 user entitlements > Returns a paginated list of user entitlement records for users associated with your firm. Each record includes the overall entitlement status and your firm's status for that entitlement, when available. ## OpenAPI ````yaml /openapi.json get /api/entitlements/user-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 ``` 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/entitlements/user-entitlements/: get: tags: - Entitlements summary: List user entitlements description: >- Returns a paginated list of user entitlement records for users associated with your firm. Each record includes the overall entitlement status and your firm's status for that entitlement, when available. operationId: api_entitlements_user_entitlements_list parameters: - in: query name: page schema: type: integer description: Page number. - in: query name: page_size schema: type: integer description: Items per page. - in: query name: status schema: type: string enum: - AUTHORIZED - PENDING - REVOKED description: Filter by overall entitlement status. responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGlobalUserEntitlementList' examples: PaginatedPendingEntitlements: 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: - user_id: 2 user_email: trader@example.com entitlement: name: CBOT data_level: l1 exchanges: - cbot status: PENDING firm_status: PENDING created: '2026-03-20T09:15:00Z' summary: First page of entitlement records description: '' security: - tokenAuth: [] components: schemas: PaginatedGlobalUserEntitlementList: 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/GlobalUserEntitlement' GlobalUserEntitlement: type: object description: Aggregate user entitlement with active-firm status context. properties: user_id: type: integer readOnly: true description: User id for the entitlement holder. user_email: type: string format: email readOnly: true description: Email address of the user this entitlement applies to. entitlement: allOf: - $ref: '#/components/schemas/Entitlement' readOnly: true description: Entitlement details for this user. status: allOf: - $ref: '#/components/schemas/Status19bEnum' readOnly: true description: >- Overall entitlement status for this user across eligible sources. `AUTHORIZED` takes precedence over `PENDING`; `PENDING` takes precedence over `REVOKED`. * `PENDING` - Pending Authorization * `AUTHORIZED` - Authorized * `REVOKED` - Revoked firm_status: type: string readOnly: true nullable: true description: >- Status of your firm's entitlement for this user. This can differ from `status` when the user remains eligible through another source. created: type: string format: date-time readOnly: true description: Timestamp when this overall entitlement record was created. required: - created - entitlement - firm_status - status - user_email - user_id Entitlement: type: object description: Basic entitlement info properties: name: type: string description: Human-readable entitlement name. maxLength: 64 data_level: allOf: - $ref: '#/components/schemas/DataLevelEnum' description: |- Market-data depth or package tier for this entitlement. * `l1` - Level 1 * `l2` - Level 2 exchanges: type: array items: type: string readOnly: true description: Exchange codes covered by this entitlement. required: - data_level - exchanges - name Status19bEnum: enum: - PENDING - AUTHORIZED - REVOKED type: string description: |- * `PENDING` - Pending Authorization * `AUTHORIZED` - Authorized * `REVOKED` - Revoked DataLevelEnum: enum: - l1 - l2 type: string description: |- * `l1` - Level 1 * `l2` - Level 2 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.