> ## 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 organization audit events

> Changes made to your organization's setup and money, newest first: trading rules,
firm settings, Time Machine settings, payouts and payout reversals, team members,
roles, API keys, webhook endpoints, plans and trader records. Each event names who
made the change (a team member or an API key), the target, and the values before
and after. Requests refused because of an API key's IP allow-list or read-only scope
appear as `api_key.refused` (at most one a minute per key and reason).

Changes to trading accounts are in `GET /audit-log`.

**Permissions:** requires **view** access to "Analytics & audit log". The actor's IP
address and user agent need **view** access to "Team & roles", except for your own
actions.

**Access:** read-only and full-access API keys. Dashboard members need view access to Analytics & audit log.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log/events
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: Instruments
    description: >-
      The contracts your organization's accounts can trade, with their
      specifications.
  - 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: Mass credit
    description: >-
      Credit back losses across many accounts after an incident, as background
      jobs you can follow, pause, export and reverse.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history, to replay or audit what happened.
  - name: Real-time streams
    description: >-
      Live events and trading data over a WebSocket, for dashboards and CRMs
      that update as things happen.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance, revenue and top traders.
  - name: Risk
    description: Firm profit and loss and plan economics.
  - name: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - name: Billing and invoices
    description: >-
      Your Hyperprop invoices, credits and billing details, with usage so far
      this month, billing cycles, forecasts and CSV exports.
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: >-
      Manage your organization's API keys: rotation, read-only keys and IP
      allowlists.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - 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/audit-log/events:
    get:
      tags:
        - Logs and health
      summary: List organization audit events
      description: >-
        Changes made to your organization's setup and money, newest first:
        trading rules,

        firm settings, Time Machine settings, payouts and payout reversals, team
        members,

        roles, API keys, webhook endpoints, plans and trader records. Each event
        names who

        made the change (a team member or an API key), the target, and the
        values before

        and after. Requests refused because of an API key's IP allow-list or
        read-only scope

        appear as `api_key.refused` (at most one a minute per key and reason).


        Changes to trading accounts are in `GET /audit-log`.


        **Permissions:** requires **view** access to "Analytics & audit log".
        The actor's IP

        address and user agent need **view** access to "Team & roles", except
        for your own

        actions.


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Analytics & audit log.
      operationId: getV1OrganizationAuditlogEvents
      parameters:
        - description: >-
            Only this action, or every action of a kind with `.*` (for example
            `api_key.*`)
          name: action
          in: query
          required: false
          example: rule.*
          schema:
            type: string
            maxLength: 60
            pattern: ^[a-z_]+(\.[a-z_]+|\.\*)?$
        - description: Events at or after this time
          x-format:
            isoDate: true
          name: from
          in: query
          required: false
          example: '2026-10-01'
          schema:
            type: string
        - description: Events before this time
          x-format:
            isoDate: true
          name: to
          in: query
          required: false
          example: '2026-10-31'
          schema:
            type: string
        - description: Page size (1-100)
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - description: >-
            Number of events to skip (at most 10,000); narrow `from`/`to` to
            reach older events
          name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 10000
            default: 0
      responses:
        '200':
          description: Audit events, newest first
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model414'
        '400':
          description: >-
            The request does not match the documented parameters or body;
            `message` names the field
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 400
                  error:
                    type: string
                    example: Bad Request
                  message:
                    type: string
                    example: '"limit" must be less than or equal to 100'
                  code:
                    type: string
                    enum:
                      - VALIDATION_ERROR
                    example: VALIDATION_ERROR
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model15'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model86'
        '500':
          description: An unexpected error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model10'
        '504':
          description: >-
            Gateway Timeout - The request did not complete within 25 seconds
            (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the
            request (for example a shorter date range).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model415'
      security:
        - X-API-Key: []
components:
  schemas:
    Model414:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model413'
    Model15:
      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
    Model86:
      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
    Model10:
      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
    Model415:
      type: object
      properties:
        statusCode:
          type: number
          example: 504
        error:
          type: string
          example: Gateway Timeout
        message:
          type: string
          example: >-
            The request did not complete within 25 seconds. Try again, or narrow
            it (for example a shorter date range).
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: REQUEST_TIMEOUT
    Model413:
      type: object
      properties:
        events:
          $ref: '#/components/schemas/Model411'
        pagination:
          $ref: '#/components/schemas/Model412'
    Model411:
      type: array
      items:
        $ref: '#/components/schemas/Model410'
    Model412:
      type: object
      properties:
        limit:
          type: integer
          example: 50
        offset:
          type: integer
          example: 0
        hasMore:
          type: boolean
          example: false
    Model410:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
        action:
          type: string
          description: >-
            What changed: `rule.*`, `org_settings.updated`,
            `time_machine_settings.updated`, `payout.executed`,
            `payout.reversed`, `api_key.*` (`api_key.refused`: a request refused
            by the key's IP allow-list or read-only scope, at most one a minute
            per key and reason), `team.*`, `role.*`, `webhook.*`, `plan.*`,
            `trader.updated`, `trader.rebound`
          example: rule.updated
        actorType:
          $ref: '#/components/schemas/actorType'
        actorUserId:
          type: string
          x-format:
            guid: true
        actorApiKeyId:
          type: string
          x-format:
            guid: true
        actorIp:
          type: string
          description: >-
            Null unless it is your own action or your role can view "Team &
            roles"
          example: 203.0.113.7
        actorUserAgent:
          type: string
          description: Same visibility as `actorIp`
          example: node-fetch/3.3
        target:
          type: string
          example: Rule "50K Evaluation"
        details:
          $ref: '#/components/schemas/details'
        createdAt:
          type: string
          x-format:
            isoDate: true
    actorType:
      type: string
      example: api-key
      enum:
        - session
        - api-key
    details:
      type: object
      description: >-
        The values before and after (`before`, `after`) and other details of the
        change
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key (`hp_live_...`), sent in the `X-API-Key` header.
        Create, rotate and restrict keys in the dashboard or with the API keys
        endpoints; an organization can have two active keys, so you can rotate
        without downtime. A **full-access** key can call every endpoint in this
        reference. A **read-only** key can call `GET` endpoints (and create a
        trading stream token); any other request returns `403 READ_ONLY_KEY`. A
        key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other
        address. Each endpoint lists which keys can call it under **Access**.

````

## Related topics

- [List all organization events](https://docs.hyperprop.com/platform-api/events/list-all-organization-events.md)
- [List all billing events](https://docs.hyperprop.com/platform-api/billing-and-invoices/list-all-billing-events.md)
- [List roles (system presets + your custom roles)](https://docs.hyperprop.com/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles.md)
- [Get organization audit log](https://docs.hyperprop.com/platform-api/logs-and-health/get-organization-audit-log.md)
- [Get events for a billing cycle](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-events-for-a-billing-cycle.md)


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