> ## 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 team members for your organization

> View all staff members who have access to your organization's dashboard.

**What are team members?**
Team members are your internal staff who can log into the Hyperprop dashboard to manage your prop firm. This is different from "traders" who are your customers.

**Roles:**
Each member has a role that defines what they can see and do. Roles are permission maps over domains (traders, payouts, billing, team, ...) with levels none/view/manage — see GET /organization/roles for the full matrix and system presets (Admin, Support, Finance, Audit).

Members created before roles existed report a legacy role: `admin` (full access) or `viewOnly` (read-only). Assign them a real role via PATCH /organization/team/{memberId}.

**What you get for each member:**
- Email address and display name
- Their role (id, name, and effective permission map)
- When they joined your organization
- Profile avatar (if set)

**Use cases:**
- Audit who has access to your dashboard
- Review team member roles before making changes
- Onboard new team members by checking existing structure

**Permissions:**
Only **admins** can view the team member list. View-only members cannot see other team members.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organization/team
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/team:
    get:
      tags:
        - Team and roles
      summary: Get team members for your organization
      description: >-
        View all staff members who have access to your organization's dashboard.


        **What are team members?**

        Team members are your internal staff who can log into the Hyperprop
        dashboard to manage your prop firm. This is different from "traders" who
        are your customers.


        **Roles:**

        Each member has a role that defines what they can see and do. Roles are
        permission maps over domains (traders, payouts, billing, team, ...) with
        levels none/view/manage — see GET /organization/roles for the full
        matrix and system presets (Admin, Support, Finance, Audit).


        Members created before roles existed report a legacy role: `admin` (full
        access) or `viewOnly` (read-only). Assign them a real role via PATCH
        /organization/team/{memberId}.


        **What you get for each member:**

        - Email address and display name

        - Their role (id, name, and effective permission map)

        - When they joined your organization

        - Profile avatar (if set)


        **Use cases:**

        - Audit who has access to your dashboard

        - Review team member roles before making changes

        - Onboard new team members by checking existing structure


        **Permissions:**

        Only **admins** can view the team member list. View-only members cannot
        see other team members.
      operationId: getV1OrganizationTeam
      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: Success - Returns all team members
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model120'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model121'
        '403':
          description: Forbidden - Only admins can view team members
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model122'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model120:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model119'
    Model121:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Invalid or expired session
    Model122:
      type: object
      properties:
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: Only organization admins can view team members
        code:
          type: string
          example: NOT_ADMIN
    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
    Model119:
      type: object
      example:
        organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34
        organizationName: FakePropFirm
        members:
          - id: f994bc02-343c-4026-8a57-afc085eca8d5
            email: sarah@propfirm.com
            fullName: Sarah Johnson
            avatarUrl: https://api.dicebear.com/9.x/glass/svg?seed=sarah
            role: admin
            joinedAt: '2025-01-15T10:00:00.000Z'
          - id: 40e7760b-3768-4513-b8c3-8d12f0f1d1da
            email: mike@propfirm.com
            fullName: Mike Chen
            avatarUrl: null
            role: viewOnly
            joinedAt: '2025-02-01T09:00:00.000Z'
        pagination:
          total: 2
          limit: 50
          offset: 0
          hasMore: false
      properties:
        organizationId:
          type: string
          description: Your organization ID
        organizationName:
          type: string
          description: Your organization name
        members:
          $ref: '#/components/schemas/members'
        pagination:
          $ref: '#/components/schemas/Model118'
    members:
      type: array
      description: Array of team members
      items:
        $ref: '#/components/schemas/Model117'
    Model118:
      type: object
      description: Pagination info
      properties:
        total:
          type: number
          description: Total number of team members
        limit:
          type: number
          description: Results per page
        offset:
          type: number
          description: Current offset
        hasMore:
          type: boolean
          description: Whether more results exist
        nextCursor:
          type: string
          description: >-
            Cursor for the next page. Pass as ?cursor= to get the next set of
            results. Null if no more results.
    Model117:
      type: object
      properties:
        id:
          type: string
          description: Team member user ID
        email:
          type: string
          description: Team member email
        fullName:
          type: string
          description: Display name (null if not set)
        avatarUrl:
          type: string
          description: Profile picture URL (null if not uploaded)
        role:
          type: string
          description: >-
            Legacy role: "admin" or "viewOnly" (kept for backwards
            compatibility)
        roleId:
          type: string
          description: Assigned role ID (null for legacy members without a role)
        roleName:
          type: string
          description: >-
            Role name, e.g. "Support" (legacy members show "Admin (legacy)" /
            "View only (legacy)")
        permissions:
          $ref: '#/components/schemas/Model116'
        joinedAt:
          type: string
          description: When this member was added to the organization
    Model116:
      type: object
      description: 'Effective permission map: domain → none/view/manage'
  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 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 traders for your organization](/platform-api/traders/get-traders-for-your-organization.md)
- [Get trading plans for your organization](/platform-api/trading-plans/get-trading-plans-for-your-organization.md)
- [Get trading accounts for your organization](/platform-api/trading-accounts/get-trading-accounts-for-your-organization.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.