> ## 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 a bulk job's items

> The job's items (one per account), in order, a page at a time: pass `pagination.nextAfter` as `after` for the next page. Filter by `status` or `errorCode` (a preview's skip reason, or a credit's error code).

Preview items carry the amount or skip reason and an explanation; credit and reversal items carry the balance before and after, or the error. An item still `pending` when its job ended reads as `cancelled`.

Requires **view** permission on traders.

```bash
curl "https://api.hyperprop.com/platform/v1/organization/jobs/5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60/items?status=skipped&limit=100" \
  -H "X-API-Key: hp_live_your_key_here"
```



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/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: 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 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, 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/jobs/{jobId}/items:
    get:
      tags:
        - Mass credit
      summary: List a bulk job's items
      description: >-
        The job's items (one per account), in order, a page at a time: pass
        `pagination.nextAfter` as `after` for the next page. Filter by `status`
        or `errorCode` (a preview's skip reason, or a credit's error code).


        Preview items carry the amount or skip reason and an explanation; credit
        and reversal items carry the balance before and after, or the error. An
        item still `pending` when its job ended reads as `cancelled`.


        Requires **view** permission on traders.


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/jobs/5d1c7a2e-3b4f-4c8d-9e0a-1b2c3d4e5f60/items?status=skipped&limit=100"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```
      operationId: getV1OrganizationJobsJobidItems
      parameters:
        - x-format:
            guid: true
          name: jobId
          in: path
          required: true
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
            enum:
              - pending
              - succeeded
              - failed
              - skipped
        - name: errorCode
          in: query
          schema:
            type: string
            maxLength: 60
        - name: after
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
      responses:
        '200':
          description: Items
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model662'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model11'
        '403':
          description: >-
            Forbidden - The caller lacks traders:view
            (`INSUFFICIENT_PERMISSIONS`)
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model663'
        '404':
          description: Job not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model446'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model6'
        '503':
          description: Mass credit is not available yet; nothing was changed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model144'
        '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/Model664'
      security:
        - X-API-Key: []
components:
  schemas:
    Model662:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/Model661'
    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
    Model663:
      type: object
      properties:
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: Insufficient permissions
        code:
          $ref: '#/components/schemas/code'
    Model446:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Job not found
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: JOB_NOT_FOUND
    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
    Model144:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 503
        error:
          type: string
          example: Error
        message:
          type: string
          example: Mass credit is not available yet; nothing was changed
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: FEATURE_NOT_READY
    Model664:
      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
    Model661:
      type: object
      properties:
        items:
          $ref: '#/components/schemas/Model659'
        pagination:
          $ref: '#/components/schemas/Model660'
    code:
      type: string
      example: INSUFFICIENT_PERMISSIONS
      enum:
        - INSUFFICIENT_PERMISSIONS
    Model659:
      type: array
      items:
        $ref: '#/components/schemas/Model658'
    Model660:
      type: object
      properties:
        limit:
          type: integer
        after:
          type: integer
        nextAfter:
          type: integer
    Model658:
      type: object
      properties:
        id:
          type: integer
          example: 1042
        ref:
          type: string
          description: The account as selected
          example: ACC-50K-000123
        status:
          $ref: '#/components/schemas/Model655'
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        accountNumber:
          type: string
          example: ACC-50K-000123
        accountStatus:
          type: string
          example: in_progress
        outcome:
          $ref: '#/components/schemas/outcome'
        amount:
          type: number
          example: 412.5
        skipReason:
          $ref: '#/components/schemas/skipReason'
        warnings:
          $ref: '#/components/schemas/Model657'
        breakdown:
          $ref: '#/components/schemas/breakdown'
        explanation:
          type: string
          example: >-
            Net P&L in the window -412.50 (realized -398.10, fees 14.40, 6
            fills): credit 412.50.
        errorCode:
          type: string
        errorMessage:
          type: string
    Model655:
      type: string
      description: '`succeeded`: to be credited. `skipped`: left out (`skipReason`).'
      example: succeeded
      enum:
        - pending
        - succeeded
        - failed
        - skipped
        - cancelled
    outcome:
      type: string
      enum:
        - credit
        - skip
    skipReason:
      type: string
      description: >-
        `ACCOUNT_NOT_FOUND`, `ACCOUNT_CLOSED` (passed, failed or expired),
        `NO_FILLS`, `NO_LOSS`, `BELOW_MINIMUM`, `ALREADY_CREDITED`, `DUPLICATE`
        (listed twice)
      enum:
        - ACCOUNT_NOT_FOUND
        - ACCOUNT_CLOSED
        - NO_FILLS
        - NO_LOSS
        - BELOW_MINIMUM
        - ALREADY_CREDITED
        - DUPLICATE
    Model657:
      type: array
      items:
        $ref: '#/components/schemas/Model656'
    breakdown:
      type: object
      description: >-
        Fills, realized P&L, fees, net P&L, losing/winning trades and the
        largest losing trades, as used
    Model656:
      type: string
      enum:
        - BALANCE_TRAIL_MISMATCH
        - CAPPED
  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 a bulk job's failed items](https://docs.hyperprop.com/platform-api/mass-credit/retry-a-bulk-jobs-failed-items.md)
- [List bulk jobs](https://docs.hyperprop.com/platform-api/mass-credit/list-bulk-jobs.md)
- [Export a bulk job's items as CSV](https://docs.hyperprop.com/platform-api/mass-credit/export-a-bulk-jobs-items-as-csv.md)
- [Pause a bulk job](https://docs.hyperprop.com/platform-api/mass-credit/pause-a-bulk-job.md)
- [Cancel a bulk job](https://docs.hyperprop.com/platform-api/mass-credit/cancel-a-bulk-job.md)


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