> ## 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 your organization profile > Retrieve your organization's public profile information. **What you get:** - Organization name and description - Contact email for support inquiries - Website URL - Logo URL (if uploaded) **Use cases:** - Display your branding in your dashboard or trader portal - Verify your organization settings are correct - Check when your profile was last updated **Authentication:** Send your organization API key in the `X-API-Key` header; the organization is resolved from the key. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/profile 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/profile: get: tags: - Organization profile summary: Get your organization profile description: >- Retrieve your organization's public profile information. **What you get:** - Organization name and description - Contact email for support inquiries - Website URL - Logo URL (if uploaded) **Use cases:** - Display your branding in your dashboard or trader portal - Verify your organization settings are correct - Check when your profile was last updated **Authentication:** Send your organization API key in the `X-API-Key` header; the organization is resolved from the key. operationId: getV1OrganizationProfile responses: '200': description: Success - Returns your organization profile content: '*/*': schema: $ref: '#/components/schemas/Model90' '401': description: Unauthorized - Invalid or missing API key content: '*/*': schema: $ref: '#/components/schemas/Model91' '403': description: Forbidden - Your account is not associated with an organization content: '*/*': schema: $ref: '#/components/schemas/Model92' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model90: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model89' Model91: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model92: 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 Model89: type: object properties: id: type: string description: Unique profile record ID example: 550e8400-e29b-41d4-a716-446655440000 organizationId: type: string description: Your organization ID example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 name: type: string description: Your organization display name example: Acme Trading Co description: type: string description: Brief description shown to traders example: Professional prop trading firm specializing in futures and forex contactEmail: type: string description: Support email for trader inquiries example: support@example.com websiteUrl: type: string description: Your organization website example: https://www.example.com logoUrl: type: string description: URL to your uploaded logo (null if not set) example: https://cdn.example.com/logos/acme-trading.png sessionOpenDelayMinutes: type: number description: Minutes after CME open before trading is allowed (0 = trade at open) example: 15 sessionCloseBufferMinutes: type: number description: Minutes before CME close that trading stops (0 = trade until close) example: 15 commissionPerSide: type: number description: Commission per side in USD (e.g., 2.00 = $2 per side, $4 round trip) example: 2 commissionPerSideMicro: type: number description: >- Commission per side in USD for CME micro contracts; null = micros charged the flat rate example: 0.5 commissionPerProduct: $ref: '#/components/schemas/commissionPerProduct' cryptoDayEndTime: type: string description: >- Local time (`HH:MM:SS`) at which a 24/7 (crypto) trading day rolls over. Applies to accounts trading BINANCE only — CME accounts always roll on the session close. example: '00:00:00' cryptoDayEndTimezone: type: string description: >- IANA timezone `cryptoDayEndTime` is read in, so the boundary follows daylight saving example: America/New_York platformPricePerUser: type: number description: >- Hyperprop platform fee per billable trader per calendar month (read-only, set by your Hyperprop agreement) example: 1.25 marketDataPriceCmeGroup: type: number description: >- CME Group market data bundle price per trader per calendar month — CME, CBOT, NYMEX, COMEX billed as one bundle (read-only, set by your Hyperprop agreement) example: 6.75 createdAt: type: string description: When the profile was created example: '2025-01-15T10:00:00.000Z' updatedAt: type: string description: When the profile was last modified example: '2025-01-20T14:30:00.000Z' commissionPerProduct: type: object description: >- Per-product commission overrides keyed by product code; null/empty = none example: MES: 0.35 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 your organization profile](/platform-api/organization-profile/update-your-organization-profile.md) - [Get traders for your organization](/platform-api/traders/get-traders-for-your-organization.md) - [Get team members for your organization](/platform-api/team-and-roles/get-team-members-for-your-organization.md) - [Get purchases for your organization](/platform-api/purchases/get-purchases-for-your-organization.md) - [Get trading plans for your organization](/platform-api/trading-plans/get-trading-plans-for-your-organization.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.