> ## 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 traders for your organization > Returns all traders who have accounts with your organization. **Search examples:** - `?search=john` - Find by partial username, displayName, or name - `?search=john@example.com` - Find by partial email - `?search=550e8400-e29b-41d4-a716-446655440000` - Find by exact userId **Lookup by your own reference:** - `?externalUserId=acme-user-4471` - Find the trader by the external ID you assigned (set via `traderExternalId` on POST /trading-accounts, or via PUT /traders/{traderId}). Exact match — no email round-trip needed. **Metadata filter:** Filter traders by any key:value in their metadata: - `?metadata=customerTier:gold` - Find gold tier customers - `?metadata=vip:true` - Find VIP traders **Combined filters:** - `?search=john&metadata=customerTier:gold` - `?search=john&startDate=2025-01-01&endDate=2025-01-31` - `?metadata=source:referral&startDate=2025-01-01&limit=10` ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/traders 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/traders: get: tags: - Traders summary: Get traders for your organization description: >- Returns all traders who have accounts with your organization. **Search examples:** - `?search=john` - Find by partial username, displayName, or name - `?search=john@example.com` - Find by partial email - `?search=550e8400-e29b-41d4-a716-446655440000` - Find by exact userId **Lookup by your own reference:** - `?externalUserId=acme-user-4471` - Find the trader by the external ID you assigned (set via `traderExternalId` on POST /trading-accounts, or via PUT /traders/{traderId}). Exact match — no email round-trip needed. **Metadata filter:** Filter traders by any key:value in their metadata: - `?metadata=customerTier:gold` - Find gold tier customers - `?metadata=vip:true` - Find VIP traders **Combined filters:** - `?search=john&metadata=customerTier:gold` - `?search=john&startDate=2025-01-01&endDate=2025-01-31` - `?metadata=source:referral&startDate=2025-01-01&limit=10` operationId: getV1OrganizationTraders parameters: - description: >- Matches email, username, display name, profile name, full name, external user ID (partial, case-insensitive), user ID (full or partial), the Hyperprop trader ID ("#00012340" or the digits), any of the trader's account numbers or account IDs, and metadata text. Results are ranked: exact email/ID first, then prefix, then substring, then account-level matches. name: search in: query required: false schema: type: string - description: >- Exact match on the external reference you set for the trader (via traderExternalId on account creation or PUT /traders/{traderId}). Deterministic lookup by your own user ID. name: externalUserId in: query required: false schema: type: string maxLength: 255 - description: Filter by metadata key:value (e.g., "vip:true", "source:referral") name: metadata in: query required: false schema: type: string - description: Filter traders who joined on or after this date (ISO 8601 format) x-format: isoDate: true name: startDate in: query required: false schema: type: string - description: Filter traders who joined on or before this date (ISO 8601 format) x-format: isoDate: true name: endDate in: query required: false schema: type: string - description: Number of traders to return (max 100) name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - description: Offset 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: Traders retrieved successfully content: '*/*': schema: $ref: '#/components/schemas/Model131' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '403': description: Forbidden - Not an organization user content: '*/*': schema: $ref: '#/components/schemas/Model132' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model131: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model130' 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 Model132: 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 Model130: type: object example: organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: FakePropFirm traders: - userId: 550e8400-e29b-41d4-a716-446655440000 email: trader@example.com externalUserId: acme-user-4471 emailVerified: true lastSignIn: '2025-01-25T14:30:00.000Z' registeredAt: '2025-01-01T10:00:00.000Z' joinedAt: '2025-01-15T10:00:00.000Z' metadata: customerTier: gold lifetimeValue: 2500 profile: username: john_trader displayName: John Trader name: John avatarUrl: https://example.com/avatar.jpg isPublic: true createdAt: '2025-01-10T08:00:00.000Z' pagination: total: 150 limit: 50 offset: 0 hasMore: true properties: organizationId: type: string organizationName: type: string traders: $ref: '#/components/schemas/traders' pagination: $ref: '#/components/schemas/Model129' traders: type: array items: $ref: '#/components/schemas/Model128' Model129: 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. Model128: type: object properties: userId: type: string email: type: string externalUserId: type: string description: Your external reference for this trader (null if not set) emailVerified: type: boolean lastSignIn: type: string registeredAt: type: string description: When the user registered on Hyperprop joinedAt: type: string description: When the trader first got an account with this organization metadata: $ref: '#/components/schemas/Model127' profile: $ref: '#/components/schemas/profile' Model127: type: object description: Custom metadata - any JSON structure profile: type: object description: User profile (null if not created) properties: username: type: string displayName: type: string name: type: string avatarUrl: type: string isPublic: type: boolean createdAt: type: string 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 accounts for your organization](/platform-api/trading-accounts/get-trading-accounts-for-your-organization.md) - [Get trading rules for your organization](/platform-api/trading-rules/get-trading-rules-for-your-organization.md) - [Get your organization profile](/platform-api/organization-profile/get-your-organization-profile.md) - [Get purchases for your organization](/platform-api/purchases/get-purchases-for-your-organization.md) - [Get team members for your organization](/platform-api/team-and-roles/get-team-members-for-your-organization.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.