> ## 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. # Add a team member with a role > Create a login for a new staff member (or link an existing account) and assign them a role. **Email new to Hyperprop (most common):** 1. You provide the member's email, name, and role. 2. Hyperprop creates a dedicated login with a strong **temporary password**. 3. The temporary password is returned **once** in this response (`tempPassword`) — copy it and share it with the member through a secure channel. 4. The member signs in at your dashboard URL and should change the password under Settings → Security. **Email already has a Hyperprop account:** The existing account is converted to a staff login and linked to your team. The response has `linkedExisting: true` and `tempPassword: null` — the person signs in with the password they already use. Note: a converted trader account can no longer log in to the trader terminal; removing them from the team converts it back to a regular account. **Important:** - An email that is already a staff login at another organization cannot be added (409 EMAIL_IN_USE). - The member's access is defined entirely by their role — see GET /organization/roles for the permission matrix. - Lost password? Use POST /organization/team/{memberId}/reset-password to generate a new temporary password. **Permissions:** requires **manage** access to "Team & roles" (admins have this by default). **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json post /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: post: tags: - Team and roles summary: Add a team member with a role description: >- Create a login for a new staff member (or link an existing account) and assign them a role. **Email new to Hyperprop (most common):** 1. You provide the member's email, name, and role. 2. Hyperprop creates a dedicated login with a strong **temporary password**. 3. The temporary password is returned **once** in this response (`tempPassword`) — copy it and share it with the member through a secure channel. 4. The member signs in at your dashboard URL and should change the password under Settings → Security. **Email already has a Hyperprop account:** The existing account is converted to a staff login and linked to your team. The response has `linkedExisting: true` and `tempPassword: null` — the person signs in with the password they already use. Note: a converted trader account can no longer log in to the trader terminal; removing them from the team converts it back to a regular account. **Important:** - An email that is already a staff login at another organization cannot be added (409 EMAIL_IN_USE). - The member's access is defined entirely by their role — see GET /organization/roles for the permission matrix. - Lost password? Use POST /organization/team/{memberId}/reset-password to generate a new temporary password. **Permissions:** requires **manage** access to "Team & roles" (admins have this by default). **Authentication:** send your organization API key in the `X-API-Key` header. operationId: postV1OrganizationTeam requestBody: content: application/json: schema: $ref: '#/components/schemas/Model551' responses: '201': description: >- Member added. For new accounts the temporary password is only shown in this response; for linked existing accounts tempPassword is null. content: '*/*': schema: $ref: '#/components/schemas/Model554' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model47' '409': description: >- Email is already on your team (MEMBER_EXISTS) or is a staff login at another organization (EMAIL_IN_USE) content: '*/*': schema: $ref: '#/components/schemas/Model555' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model551: type: object properties: email: type: string description: >- Work email for the staff member. If the email is new to Hyperprop a dedicated login is created; if it already has a Hyperprop account, that account is linked to your team instead. example: sarah@propfirm.com x-format: email: true fullName: type: string description: Display name shown in the dashboard and audit log example: Sarah Johnson minLength: 1 maxLength: 120 roleId: type: string description: >- Role to assign. Get available roles (system presets + your custom roles) from GET /organization/roles. example: 7e0d1c9a-3f2b-4d5e-8a6f-1b2c3d4e5f60 x-format: guid: true required: - email - fullName - roleId Model554: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model553' Model47: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model555: type: object properties: statusCode: type: number example: 409 error: type: string example: Conflict message: type: string example: >- This email is already a staff login at another organization. Use a different email (a work alias like name+ops@yourfirm.com works). code: type: string example: EMAIL_IN_USE 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 Model553: type: object example: id: 40e7760b-3768-4513-b8c3-8d12f0f1d1da email: sarah@propfirm.com fullName: Sarah Johnson roleId: 7e0d1c9a-3f2b-4d5e-8a6f-1b2c3d4e5f60 roleName: Support permissions: analytics: view traders: manage payouts: view plans: view webhooks: none operations: manage billing: none team: none settings: none tempPassword: Kw4n-Xr8t-Mz2p-Hq7v linkedExisting: false properties: id: type: string description: Member user ID email: type: string description: Member email (login) fullName: type: string description: Display name roleId: type: string description: Assigned role ID roleName: type: string description: Assigned role name permissions: $ref: '#/components/schemas/Model552' tempPassword: type: string description: >- Temporary password — shown ONCE, share securely with the member. Null when an existing account was linked (they keep their current password). linkedExisting: type: boolean description: >- True when the email already had a Hyperprop account and it was linked to your team instead of creating a new login Model552: 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 - [Change a team member's role](/platform-api/team-and-roles/change-a-team-members-role.md) - [Remove a team member](/platform-api/team-and-roles/remove-a-team-member.md) - [Get team members for your organization](/platform-api/team-and-roles/get-team-members-for-your-organization.md) - [Generate a new temporary password for a team member](/platform-api/team-and-roles/generate-a-new-temporary-password-for-a-team-member.md) - [List roles (system presets + your custom roles)](/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.