> ## 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 the accounts of a background run

> Every account of a batch's background revert (or undo), in the order they were sent, with its outcome so far. Use it to follow a large run account by account, to see why accounts failed, and to check which accounts a cancelled run left untouched.

| `status` | Meaning |
|---|---|
| `pending` | Not processed yet, or waiting to retry after a temporary error (`attempts` > 0, `nextAttemptAt` set) |
| `running` | Being processed now |
| `succeeded` | Reverted (or restored, for an undo) |
| `failed` | Could not be processed after its retries. `errorCode` and `errorMessage` say why (codes as in the single-account revert, or the undo endpoint) |
| `cancelled` | Left untouched because the run was cancelled |

Only batches that ran in the background have this list. A batch that ran within its request answers `404 NO_JOB`; its accounts are in `GET /revert-batches/{batchId}`.

**Example — the failed accounts:**
```bash
curl "https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/items?status=failed" \
  -H "X-API-Key: hp_live_your_key_here"
```



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/items
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/revert-batches/{batchId}/items:
    get:
      tags:
        - Time Machine
      summary: List the accounts of a background run
      description: >-
        Every account of a batch's background revert (or undo), in the order
        they were sent, with its outcome so far. Use it to follow a large run
        account by account, to see why accounts failed, and to check which
        accounts a cancelled run left untouched.


        | `status` | Meaning |

        |---|---|

        | `pending` | Not processed yet, or waiting to retry after a temporary
        error (`attempts` > 0, `nextAttemptAt` set) |

        | `running` | Being processed now |

        | `succeeded` | Reverted (or restored, for an undo) |

        | `failed` | Could not be processed after its retries. `errorCode` and
        `errorMessage` say why (codes as in the single-account revert, or the
        undo endpoint) |

        | `cancelled` | Left untouched because the run was cancelled |


        Only batches that ran in the background have this list. A batch that ran
        within its request answers `404 NO_JOB`; its accounts are in `GET
        /revert-batches/{batchId}`.


        **Example — the failed accounts:**

        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/revert-batches/a1b2c3d4-e5f6-7890-abcd-ef1234567890/items?status=failed"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```
      operationId: getV1OrganizationRevertbatchesBatchidItems
      parameters:
        - description: Batch id returned by the revert call
          x-format:
            guid: true
          name: batchId
          in: path
          required: true
          schema:
            type: string
        - description: Only accounts in this state
          name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - running
              - succeeded
              - failed
              - cancelled
        - description: >-
            Which background run of the batch: the revert or its undo. Default:
            the latest one.
          name: kind
          in: query
          required: false
          schema:
            type: string
            enum:
              - revert
              - undo
        - description: Accounts per page
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
        - description: Accounts to skip
          name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Accounts of the run
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model590'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model11'
        '403':
          description: Access denied
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model63'
        '404':
          description: Batch not found, or it has no background run
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model592'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model6'
        '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:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model593'
      security:
        - X-API-Key: []
components:
  schemas:
    Model590:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model589'
    Model11:
      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
    Model63:
      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
    Model592:
      type: object
      properties:
        success:
          type: boolean
          example: false
        code:
          $ref: '#/components/schemas/Model591'
        message:
          type: string
          example: This batch has no background run
    Model6:
      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
    Model593:
      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
    Model589:
      type: object
      example:
        batchId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        jobId: f47ac10b-58cc-4372-a567-0e02b2c3d479
        kind: revert
        total: 1
        limit: 100
        offset: 0
        items:
          - accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
            accountNumber: ACC-7845KXPQ
            status: failed
            attempts: 5
            errorCode: BALANCE_AT_INSTANT_ERROR
            errorMessage: Failed to compute balance at revertTo
            nextAttemptAt: null
            finishedAt: '2026-10-15T15:44:02.000Z'
      properties:
        batchId:
          type: string
        jobId:
          type: string
          description: The background run (as in `job.jobId` on the batch)
        kind:
          $ref: '#/components/schemas/Model585'
        total:
          type: number
          description: Accounts matching the filter
        limit:
          type: number
        offset:
          type: number
        items:
          $ref: '#/components/schemas/Model588'
    Model591:
      type: string
      example: NO_JOB
      enum:
        - BATCH_NOT_FOUND
        - NO_JOB
    Model585:
      type: string
      enum:
        - revert
        - undo
    Model588:
      type: array
      items:
        $ref: '#/components/schemas/Model587'
    Model587:
      type: object
      properties:
        accountId:
          type: string
        accountNumber:
          type: string
        status:
          $ref: '#/components/schemas/Model586'
        attempts:
          type: number
          description: Attempts so far
        errorCode:
          type: string
          description: Latest error (failed, or pending a retry)
        errorMessage:
          type: string
        nextAttemptAt:
          type: string
          description: When a retry is due (pending only)
        finishedAt:
          type: string
    Model586:
      type: string
      enum:
        - pending
        - running
        - succeeded
        - failed
        - cancelled
  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

- [Retry the failed accounts of a background run](/platform-api/time-machine/retry-the-failed-accounts-of-a-background-run.md)
- [Cancel a background run](/platform-api/time-machine/cancel-a-background-run.md)
- [List revert batches](/platform-api/time-machine/list-revert-batches.md)
- [Inspect a revert batch](/platform-api/time-machine/inspect-a-revert-batch.md)
- [List close-all runs](/platform-api/trading-accounts/list-close-all-runs.md)


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