> ## 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 roles (system presets + your custom roles) > Roles define what each team member can see and do in the dashboard and API. A role is a permission map of **domain → level**: **Domains:** | Domain | Covers | |--------|--------| | `analytics` | Analytics dashboard, audit log | | `traders` | Traders, accounts, lockouts, end-of-day snapshots | | `payouts` | Payout eligibility, payout execution, payout history | | `plans` | Trading plans and trading rules | | `webhooks` | Webhook endpoints and deliveries | | `operations` | Time machine, revert trading day, bulk operations | | `billing` | Billing cycles, events, monthly summary | | `team` | Team members and roles | | `settings` | Organization profile, API keys | **Levels:** `none` (hidden), `view` (read-only), `manage` (read + write). **System presets** (available to every organization, read-only): - **Admin** — manage everything - **Support** — manage traders/accounts and operations, view payout readiness; no billing, team, or settings - **Finance** — execute payouts, view billing and analytics; read-only accounts - **Audit** — view everything, change nothing You can also create **custom roles** with any combination (POST /organization/roles). **Permissions:** requires **view** access to "Team & roles" (mutations require **manage**). **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/roles 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/roles: get: tags: - Team and roles summary: List roles (system presets + your custom roles) description: >- Roles define what each team member can see and do in the dashboard and API. A role is a permission map of **domain → level**: **Domains:** | Domain | Covers | |--------|--------| | `analytics` | Analytics dashboard, audit log | | `traders` | Traders, accounts, lockouts, end-of-day snapshots | | `payouts` | Payout eligibility, payout execution, payout history | | `plans` | Trading plans and trading rules | | `webhooks` | Webhook endpoints and deliveries | | `operations` | Time machine, revert trading day, bulk operations | | `billing` | Billing cycles, events, monthly summary | | `team` | Team members and roles | | `settings` | Organization profile, API keys | **Levels:** `none` (hidden), `view` (read-only), `manage` (read + write). **System presets** (available to every organization, read-only): - **Admin** — manage everything - **Support** — manage traders/accounts and operations, view payout readiness; no billing, team, or settings - **Finance** — execute payouts, view billing and analytics; read-only accounts - **Audit** — view everything, change nothing You can also create **custom roles** with any combination (POST /organization/roles). **Permissions:** requires **view** access to "Team & roles" (mutations require **manage**). **Authentication:** send your organization API key in the `X-API-Key` header. operationId: getV1OrganizationRoles responses: '200': description: System presets and custom roles content: '*/*': schema: $ref: '#/components/schemas/Model115' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model47' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model115: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model114' 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 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 Model114: type: object properties: roles: $ref: '#/components/schemas/roles' roles: type: array items: $ref: '#/components/schemas/Model113' Model113: type: object properties: id: type: string name: type: string example: Support description: type: string permissions: $ref: '#/components/schemas/Model112' isSystem: type: boolean description: System presets cannot be edited or deleted memberCount: type: number description: How many of your members use this role createdAt: type: string updatedAt: type: string Model112: type: object description: 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 - [Update a custom role](/platform-api/team-and-roles/update-a-custom-role.md) - [Delete an unused custom role](/platform-api/team-and-roles/delete-an-unused-custom-role.md) - [Create a custom role](/platform-api/team-and-roles/create-a-custom-role.md) - [Get team members for your organization](/platform-api/team-and-roles/get-team-members-for-your-organization.md) - [Add a team member with a role](/platform-api/team-and-roles/add-a-team-member-with-a-role.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.