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

> Get the complete audit log of all trading account changes for your organization.

Shows all changes (single updates and bulk operations) with full before/after values.

**Filters:**
| Filter | Description |
|--------|-------------|
| `accountId` | Filter by specific account |
| `adminEmail` | Filter by admin (partial match) |
| `batchId` | Filter by bulk operation batch |
| `startDate` | Changes from this date onwards |
| `endDate` | Changes until this date |

**Example:**
```bash
# Get all recent changes
curl "https://api.hyperprop.com/platform/v1/organization/audit-log" \
  -H "X-API-Key: hp_live_your_key_here"

# Get changes from a specific date range
curl ".../audit-log?startDate=2026-02-17&endDate=2026-02-18"

# Get changes by a specific admin
curl ".../audit-log?adminEmail=admin@example.com"
```

**Response includes:**
- All changes with before/after values
- Account number for each change
- List of recent bulk operations



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organization/audit-log
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/audit-log:
    get:
      tags:
        - Logs and health
      summary: Get organization audit log
      description: >-
        Get the complete audit log of all trading account changes for your
        organization.


        Shows all changes (single updates and bulk operations) with full
        before/after values.


        **Filters:**

        | Filter | Description |

        |--------|-------------|

        | `accountId` | Filter by specific account |

        | `adminEmail` | Filter by admin (partial match) |

        | `batchId` | Filter by bulk operation batch |

        | `startDate` | Changes from this date onwards |

        | `endDate` | Changes until this date |


        **Example:**

        ```bash

        # Get all recent changes

        curl "https://api.hyperprop.com/platform/v1/organization/audit-log" \
          -H "X-API-Key: hp_live_your_key_here"

        # Get changes from a specific date range

        curl ".../audit-log?startDate=2026-02-17&endDate=2026-02-18"


        # Get changes by a specific admin

        curl ".../audit-log?adminEmail=admin@example.com"

        ```


        **Response includes:**

        - All changes with before/after values

        - Account number for each change

        - List of recent bulk operations
      operationId: getV1OrganizationAuditlog
      parameters:
        - description: Filter by specific account ID
          x-format:
            guid: true
          name: accountId
          in: query
          required: false
          schema:
            type: string
        - description: Filter by admin email (partial match)
          name: adminEmail
          in: query
          required: false
          schema:
            type: string
        - description: Filter by batch ID
          x-format:
            guid: true
          name: batchId
          in: query
          required: false
          schema:
            type: string
        - description: Filter changes from this date
          x-format:
            isoDate: true
          name: startDate
          in: query
          required: false
          schema:
            type: string
        - description: Filter changes until this date
          x-format:
            isoDate: true
          name: endDate
          in: query
          required: false
          schema:
            type: string
        - description: Results per page
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - description: Offset for pagination
          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
        - description: >-
            Sort results. Format: `field:direction` where direction is `asc` or
            `desc`.


            **Allowed fields:** `created_at`


            **Default:** `created_at:desc`


            **Examples:** `created_at:asc`, `current_balance:desc`
          name: sort
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Audit log retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model56'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model56:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model55'
    Model9:
      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
    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
    Model55:
      type: object
      example:
        organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34
        organizationName: FakePropFirm
        changes:
          - id: b1c2d3e4-f5a6-7890-abcd-ef1234567890
            accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
            accountNumber: ACC-7845KXPQ
            adminEmail: admin@propfirm.com
            batchId: null
            changes:
              currentBalance:
                old: 50000
                new: 51250
            reason: 'Customer support ticket #4521 - balance correction'
            createdAt: '2026-02-17T14:30:00.000Z'
          - id: c2d3e4f5-a6b7-8901-bcde-f12345678901
            accountId: 8d0f7780-8536-51ef-b55c-f18gd2g01bf8
            accountNumber: ACC-9921MZPL
            adminEmail: admin@propfirm.com
            batchId: e4f5a6b7-c8d9-0123-efab-456789012345
            changes:
              status:
                old: failed
                new: in_progress
            reason: Server maintenance compensation - bulk reset
            createdAt: '2026-02-16T09:15:00.000Z'
        recentBulkOperations:
          - batchId: e4f5a6b7-c8d9-0123-efab-456789012345
            adminEmail: admin@propfirm.com
            reason: Server maintenance compensation - bulk reset
            performedAt: '2026-02-16T09:15:00.000Z'
        pagination:
          total: 46
          limit: 50
          offset: 0
          hasMore: false
      properties:
        organizationId:
          type: string
          x-format:
            guid: true
        organizationName:
          type: string
        changes:
          $ref: '#/components/schemas/Model52'
        recentBulkOperations:
          $ref: '#/components/schemas/recentBulkOperations'
        pagination:
          $ref: '#/components/schemas/Model54'
    Model52:
      type: array
      items:
        $ref: '#/components/schemas/Model51'
    recentBulkOperations:
      type: array
      items:
        $ref: '#/components/schemas/Model53'
    Model54:
      type: object
      properties:
        total:
          type: number
        limit:
          type: number
        offset:
          type: number
        hasMore:
          type: boolean
        nextCursor:
          type: string
          description: >-
            Cursor for the next page. Pass as ?cursor= to get the next set of
            results. Null if no more results.
    Model51:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
        accountId:
          type: string
          x-format:
            guid: true
        accountNumber:
          type: string
        adminEmail:
          type: string
        batchId:
          type: string
          x-format:
            guid: true
        changes:
          $ref: '#/components/schemas/changes'
        reason:
          type: string
        createdAt:
          type: string
    Model53:
      type: object
      properties:
        batchId:
          type: string
          x-format:
            guid: true
        adminEmail:
          type: string
        reason:
          type: string
        performedAt:
          type: string
    changes:
      type: object
  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 team members for your organization](/platform-api/team-and-roles/get-team-members-for-your-organization.md)
- [MCP connector (AI agents)](/guides/mcp-connector.md)
- [Introduction](/introduction.md)
- [Get an account's event log and session history](/platform-api/trading-accounts/get-an-accounts-event-log-and-session-history.md)
- [List API request logs](/platform-api/logs-and-health/list-api-request-logs.md)


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