> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # List all active lockouts > Returns all active lockouts across your organization. **Use cases:** - Dashboard overview of all locked accounts - Audit which accounts are currently restricted - Review lockout reasons before bulk unlocking **`locked_by` values:** | Value | Meaning | User can remove? | |-------|---------|-----------------| | `admin` | Created by org admin | No | | `user` | Self-imposed by trader | Only `trade_clock` when flat | | `system` | Auto-lockout (DTD breach, etc.) | No | All lockouts can be removed by admin regardless of `locked_by`. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/lockouts openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/lockouts: get: tags: - Lockouts summary: List all active lockouts description: |- Returns all active lockouts across your organization. **Use cases:** - Dashboard overview of all locked accounts - Audit which accounts are currently restricted - Review lockout reasons before bulk unlocking **`locked_by` values:** | Value | Meaning | User can remove? | |-------|---------|-----------------| | `admin` | Created by org admin | No | | `user` | Self-imposed by trader | Only `trade_clock` when flat | | `system` | Auto-lockout (DTD breach, etc.) | No | All lockouts can be removed by admin regardless of `locked_by`. operationId: getV1OrganizationLockouts parameters: - description: 'Results per page (default: 50, max: 100)' name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - description: Pagination offset name: offset in: query schema: type: integer minimum: 0 default: 0 - description: >- Cursor for pagination. Pass the `nextCursor` value from the previous response to get the next page. When using cursor, do not send `offset` — it will be ignored. **How it works:** The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages. **Backwards compatible:** If you don't send a cursor, offset/limit pagination works as before. name: cursor in: query required: false schema: type: string responses: '200': description: Active lockouts retrieved content: '*/*': schema: $ref: '#/components/schemas/Model82' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model82: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model81' Model9: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model81: type: object example: organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: FakePropFirm lockouts: - id: b1c2d3e4-f5a6-7890-abcd-ef1234567890 accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: ACC-7845KXPQ userId: f994bc02-343c-4026-8a57-afc085eca8d5 mode: admin reason: 'Risk review: unusual trading pattern detected' lockedBy: admin startsAt: '2026-03-12T15:00:00.000Z' endsAt: '2026-04-01T00:00:00.000Z' createdAt: '2026-03-12T15:00:00.000Z' - id: c2d3e4f5-a6b7-8901-bcde-f12345678901 accountId: 8d0f7780-8536-51ef-b55c-f18gd2g01bf8 accountNumber: ACC-9921MZPL userId: 40e7760b-3768-4513-b8c3-8d12f0f1d1da mode: trade_clock reason: Initiated by user lockedBy: user startsAt: '2026-03-12T14:00:00.000Z' endsAt: '2026-03-12T16:00:00.000Z' createdAt: '2026-03-12T14:00:00.000Z' pagination: total: 2 limit: 50 offset: 0 hasMore: false nextCursor: null properties: organizationId: type: string organizationName: type: string lockouts: $ref: '#/components/schemas/lockouts' pagination: $ref: '#/components/schemas/Model80' lockouts: type: array items: type: string Model80: type: object properties: total: type: number limit: type: number offset: type: number hasMore: type: boolean nextCursor: type: string description: >- Cursor for the next page. Pass as ?cursor= to get the next set of results. Null if no more results. securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Update active lockout](/platform-api/lockouts/update-active-lockout.md) - [List all webhooks](/platform-api/webhooks/list-all-webhooks.md) - [Create or update account lockout](/trade-api/account/create-or-update-account-lockout.md) - [List all billing events](/platform-api/billing/list-all-billing-events.md) - [Remove lockout from account](/platform-api/lockouts/remove-lockout-from-account.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.