> ## 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. # Get trading accounts for your organization > Retrieve all trading accounts for your organization with powerful filtering and search. **What is a trading account?** A trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. **Account types:** | Type | Description | |------|-------------| | `evaluation` | Challenge account where trader must hit profit target | | `sim_funded` | Simulated funded account after passing evaluation | **Account statuses:** | Status | Description | |--------|-------------| | `not_started` | Account created but trader hasn't begun trading | | `in_progress` | Trader is actively trading | | `passed` | Trader hit profit target and passed the evaluation | | `failed` | Trader violated a rule (max loss, drawdown, etc.) | | `expired` | Evaluation period ended without passing | **What you get for each account:** - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer's email and name) - Linked Hyperprop user (or the one-time `importKey` while still unlinked) - Purchase details (what they paid) - Custom metadata (any JSON data you need) **Search:** The `search` parameter is flexible and matches: - Account number (partial match): `?search=ACME-100K` - Trader email (partial match): `?search=john@` - Trader name (partial match): `?search=John` - Account ID (exact match): `?search=7c9e6679-7425-40de-944b-e07fc1f90ae7` - User ID (exact match): `?search=f994bc02-343c-4026-8a57-afc085eca8d5` **Lookup by your own customer ID:** `?customerId=acme-cust-4471` returns all accounts of the customer whose `customerId` you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (`?externalRef=` still works as a deprecated alias.) **Example queries:** ```http # Find all active evaluations GET /organization/trading-accounts?type=evaluation&status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed&startDate=2025-01-01&endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high&status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25&offset=25 ``` **Use cases:** - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/trading-accounts 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/trading-accounts: get: tags: - Trading accounts summary: Get trading accounts for your organization description: >- Retrieve all trading accounts for your organization with powerful filtering and search. **What is a trading account?** A trading account represents a trader's evaluation or sim-funded account. Each account tracks their progress, balance, and performance against your trading rules. **Account types:** | Type | Description | |------|-------------| | `evaluation` | Challenge account where trader must hit profit target | | `sim_funded` | Simulated funded account after passing evaluation | **Account statuses:** | Status | Description | |--------|-------------| | `not_started` | Account created but trader hasn't begun trading | | `in_progress` | Trader is actively trading | | `passed` | Trader hit profit target and passed the evaluation | | `failed` | Trader violated a rule (max loss, drawdown, etc.) | | `expired` | Evaluation period ended without passing | **What you get for each account:** - Account details (number, type, status, balances) - Performance data and high water mark - Trading plan and rules applied - Trader info (your customer's email and name) - Linked Hyperprop user (or the one-time `importKey` while still unlinked) - Purchase details (what they paid) - Custom metadata (any JSON data you need) **Search:** The `search` parameter is flexible and matches: - Account number (partial match): `?search=ACME-100K` - Trader email (partial match): `?search=john@` - Trader name (partial match): `?search=John` - Account ID (exact match): `?search=7c9e6679-7425-40de-944b-e07fc1f90ae7` - User ID (exact match): `?search=f994bc02-343c-4026-8a57-afc085eca8d5` **Lookup by your own customer ID:** `?customerId=acme-cust-4471` returns all accounts of the customer whose `customerId` you set at creation (or via PATCH) — an exact-match, deterministic lookup for reconciliation. (`?externalRef=` still works as a deprecated alias.) **Example queries:** ```http # Find all active evaluations GET /organization/trading-accounts?type=evaluation&status=in_progress # Search for a specific trader GET /organization/trading-accounts?search=john@example.com # Get all passed accounts this month GET /organization/trading-accounts?status=passed&startDate=2025-01-01&endDate=2025-01-31 # Find high-priority accounts that are in progress GET /organization/trading-accounts?metadata=priority:high&status=in_progress # Page through results (page 2, 25 per page) GET /organization/trading-accounts?limit=25&offset=25 ``` **Use cases:** - Monitor active evaluations in real-time - Find accounts for a specific trader - Generate pass/fail reports - Track VIP or promotional accounts - Audit account history for compliance operationId: getV1OrganizationTradingaccounts parameters: - description: >- Searches the whole organization, not just the current page. Matches account number, customer ID, import key, your external purchase ID, account ID or user ID (full or partial, case-insensitive), the Hyperprop trader ID ("#00012340" or just the digits), trader email, full name, username, display name, external user ID, and metadata text. Minimum 2 characters. Results are ranked: exact identifier or email first, then prefix, then substring, then trader-level and metadata matches; pagination and total apply to the ranked result set. name: search in: query required: false schema: type: string - description: Filter by account type name: type in: query required: false schema: type: string enum: - evaluation - sim_funded - competition - description: Filter by account status name: status in: query required: false schema: type: string enum: - not_started - in_progress - passed - failed - expired - description: Filter by trading plan (the plan the account was purchased under) x-format: guid: true name: planId in: query required: false schema: type: string - description: Filter by metadata key:value (e.g., "vip:true", "source:affiliate") name: metadata in: query required: false schema: type: string - description: >- Exact match on the customerId you set at account creation (or via PATCH). Deterministic lookup of all accounts belonging to one of your customers. name: customerId in: query required: false schema: type: string maxLength: 255 - description: DEPRECATED alias for customerId — use customerId instead. name: externalRef in: query required: false schema: type: string maxLength: 255 - description: >- true = only accounts with no trader attached yet (their one-time importKey is included in each row); false = only linked accounts. Omit for both. name: unlinked in: query required: false schema: type: boolean - description: Only include accounts created from this date onwards x-format: isoDate: true name: startDate in: query required: false schema: type: string - description: Only include accounts created up to this date x-format: isoDate: true name: endDate in: query required: false schema: type: string - description: 'Results per page (default: 50, max: 100)' name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - description: Skip this many results (for pagination) 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: Success - Returns paginated list of trading accounts content: '*/*': schema: $ref: '#/components/schemas/Model139' '401': description: Unauthorized - Invalid or missing API key content: '*/*': schema: $ref: '#/components/schemas/Model140' '403': description: Forbidden - Your account is not associated with an organization content: '*/*': schema: $ref: '#/components/schemas/Model141' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model139: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model138' Model140: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model141: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: This endpoint is only available for organization users code: type: string example: NOT_ORGANIZATION_USER 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 Model138: type: object example: organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: FakePropFirm accounts: - id: 7c9e6679-7425-40de-944b-e07fc1f90ae7 accountNumber: ACC-7845KXPQ type: evaluation status: in_progress initialBalance: 50000 currentBalance: 52150 highWaterMark: 53200 dailyStartingBalance: 51800 startedAt: '2026-02-01T09:00:00.000Z' completedAt: null violationReason: null metadata: source: affiliate_program userId: f994bc02-343c-4026-8a57-afc085eca8d5 userEmail: trader@example.com userAvatarUrl: https://api.dicebear.com/9.x/glass/svg?seed=trader tradingPlan: id: 09c93da5-f057-4cc5-82da-ff9220292c94 name: 50K Challenge accountSize: 50000 tradingRule: id: 6bec94a1-425b-47be-bb41-a80e3140e2e7 name: Standard Rules profitTarget: 4000 maxLoss: 2500 maxDrawdown: 5 drawdownType: static trader: email: john.smith@email.com name: John Smith purchase: id: f47ac10b-58cc-4372-a567-0e02b2c3d479 purchaseDate: '2026-01-28T10:00:00.000Z' pricePaid: 299 currency: USD metadata: stripePaymentId: pi_3ABC123 createdAt: '2026-01-28T10:00:00.000Z' updatedAt: '2026-02-17T14:30:00.000Z' pagination: total: 142 limit: 50 offset: 0 hasMore: true properties: organizationId: type: string description: Your organization ID organizationName: type: string description: Your organization name accounts: $ref: '#/components/schemas/Model136' pagination: $ref: '#/components/schemas/Model137' Model136: type: array description: Array of trading accounts items: $ref: '#/components/schemas/Model135' Model137: 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. Model135: type: object properties: id: type: string description: Unique account ID accountNumber: type: string description: Human-readable account number type: type: string description: Account type (evaluation, sim_funded, competition) status: type: string description: Current account status initialBalance: type: number description: Starting balance currentBalance: type: number description: Current balance highWaterMark: type: number description: Highest balance achieved dailyStartingBalance: type: number description: Balance at start of trading day startedAt: type: string description: When trading started completedAt: type: string description: When completed/failed violationReason: type: string description: Reason for failure metadata: $ref: '#/components/schemas/Model133' userId: type: string description: Hyperprop user ID userEmail: type: string description: Hyperprop user email userAvatarUrl: type: string description: User avatar URL tradingPlan: $ref: '#/components/schemas/Model134' tradingRule: $ref: '#/components/schemas/tradingRule' trader: $ref: '#/components/schemas/trader' purchase: $ref: '#/components/schemas/purchase' createdAt: type: string updatedAt: type: string Model133: type: object description: Custom metadata Model134: type: object properties: id: type: string name: type: string accountSize: type: number tradingRule: type: object properties: id: type: string name: type: string profitTarget: type: number maxLoss: type: number maxDrawdown: type: number drawdownType: type: string trader: type: object properties: email: type: string name: type: string purchase: type: object properties: id: type: string purchaseDate: type: string pricePaid: type: number currency: type: string metadata: $ref: '#/components/schemas/changes' changes: type: object 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 - [Get trading plans for your organization](/platform-api/trading-plans/get-trading-plans-for-your-organization.md) - [Get trading rules for your organization](/platform-api/trading-rules/get-trading-rules-for-your-organization.md) - [Get a specific trading account](/platform-api/trading-accounts/get-a-specific-trading-account.md) - [Get purchases for your organization](/platform-api/purchases/get-purchases-for-your-organization.md) - [Get your organization profile](/platform-api/organization-profile/get-your-organization-profile.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.