> ## 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 API request logs > Stripe-style request log of every authenticated call your organization made to the Platform API (both `X-API-Key` and dashboard-session requests), newest first. Each entry includes the HTTP method, path, status code, machine-readable error code, latency, caller identity (API key vs dashboard session), source IP, user agent, query parameters, and the response body (capped at 2 KiB). **Filters:** - `method` — GET, POST, PUT, PATCH, DELETE - `status` — `succeeded` (2xx/3xx), `failed` (4xx+5xx), `4xx`, `5xx` - `path` — substring match, e.g. `payouts` **Example:** ```http GET /platform/v1/organization/api-logs?status=failed&limit=25 X-API-Key: hp_live_... ``` Logging starts from the deployment of this feature; earlier traffic is not backfilled. Requests to the log/health endpoints themselves and the WebSocket stream are not logged. **Permissions:** requires **view** access to "Webhooks". **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/api-logs 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/api-logs: get: tags: - Logs and health summary: List API request logs description: >- Stripe-style request log of every authenticated call your organization made to the Platform API (both `X-API-Key` and dashboard-session requests), newest first. Each entry includes the HTTP method, path, status code, machine-readable error code, latency, caller identity (API key vs dashboard session), source IP, user agent, query parameters, and the response body (capped at 2 KiB). **Filters:** - `method` — GET, POST, PUT, PATCH, DELETE - `status` — `succeeded` (2xx/3xx), `failed` (4xx+5xx), `4xx`, `5xx` - `path` — substring match, e.g. `payouts` **Example:** ```http GET /platform/v1/organization/api-logs?status=failed&limit=25 X-API-Key: hp_live_... ``` Logging starts from the deployment of this feature; earlier traffic is not backfilled. Requests to the log/health endpoints themselves and the WebSocket stream are not logged. **Permissions:** requires **view** access to "Webhooks". **Authentication:** send your organization API key in the `X-API-Key` header. operationId: getV1OrganizationApilogs parameters: - name: method in: query required: false schema: type: string enum: - GET - POST - PUT - PATCH - DELETE - name: status in: query required: false schema: type: string enum: - succeeded - failed - 4xx - 5xx - description: Substring match on the request path name: path in: query required: false schema: type: string maxLength: 200 - name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 50 - name: offset in: query schema: type: integer minimum: 0 default: 0 responses: '200': description: Paginated API request logs, newest first content: '*/*': schema: $ref: '#/components/schemas/Model50' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '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: Model50: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model49' 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 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 Model49: type: object properties: logs: $ref: '#/components/schemas/logs' pagination: $ref: '#/components/schemas/pagination' logs: type: array items: $ref: '#/components/schemas/Model48' pagination: type: object properties: total: type: number example: 1420 limit: type: number example: 50 offset: type: number example: 0 hasMore: type: boolean example: true Model48: type: object properties: id: type: string x-format: guid: true requestId: type: string example: 1721650000000:host:12345:abcdef:10001 method: type: string example: POST path: type: string example: /platform/v1/organization/lockouts route: type: string example: /platform/v1/organization/lockouts statusCode: type: integer example: 400 errorCode: type: string example: VALIDATION_ERROR latencyMs: type: number example: 85 authType: $ref: '#/components/schemas/authType' apiKeyId: type: string x-format: guid: true userId: type: string x-format: guid: true ip: type: string example: 203.0.113.7 userAgent: type: string example: node-fetch/3.3 query: $ref: '#/components/schemas/query' responseBody: type: string description: Response body capped at 2 KiB createdAt: type: string x-format: isoDate: true authType: type: string example: api-key enum: - api-key - session query: 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 organization audit log](/platform-api/logs-and-health/get-organization-audit-log.md) - [List trader identity bindings (customer ⇄ Hyperprop login)](/platform-api/traders/list-trader-identity-bindings-customer-⇄-hyperprop-login.md) - [Get integration health (alerts, errors, insights)](/platform-api/logs-and-health/get-integration-health-alerts-errors-insights.md) - [Upload organization logo](/platform-api/organization-profile/upload-organization-logo.md) - [Delete organization logo](/platform-api/organization-profile/delete-organization-logo.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.