> ## Documentation Index
> Fetch the complete documentation index at: https://docs.meteroid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List batch jobs

> List batch jobs with optional filtering by type and status.



## OpenAPI

````yaml https://api.meteroid.com/api-docs/openapi.json get /api/v1/batch-jobs
openapi: 3.1.0
info:
  title: meteroid
  description: ''
  license:
    name: LicenseRef-Proprietary
    identifier: LicenseRef-Proprietary
  version: 0.1.0
servers: []
security: []
tags:
  - name: Meteroid
    description: Meteroid API
  - name: Add-ons
  - name: Batch Jobs
  - name: Checkout Sessions
  - name: Connect
    description: Manage connected accounts (Express & Standard)
  - name: Coupons
  - name: Credit Notes
  - name: Customers
  - name: Entitlements
  - name: Events
  - name: Features
  - name: Invoices
  - name: Metrics
  - name: OAuth
    description: OAuth 2.0 token endpoints (public, client-credentials auth)
  - name: OAuth Apps
    description: Manage OAuth applications for Connect integrations
  - name: Plans
  - name: Product Families
  - name: Products
  - name: Subscriptions
  - name: Usage
paths:
  /api/v1/batch-jobs:
    get:
      tags:
        - Batch Jobs
      summary: List batch jobs
      description: List batch jobs with optional filtering by type and status.
      operationId: list_batch_jobs
      parameters:
        - name: job_type
          in: query
          required: false
          schema:
            type: string
            title: BatchJobType
            enum:
              - EVENT_CSV_IMPORT
              - CUSTOMER_CSV_IMPORT
              - SUBSCRIPTION_CSV_IMPORT
              - SUBSCRIPTION_PLAN_MIGRATION
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              title: BatchJobStatus
              enum:
                - PENDING
                - CHUNKING
                - PROCESSING
                - COMPLETED
                - COMPLETED_WITH_ERRORS
                - FAILED
                - CANCELLED
        - name: page
          in: query
          description: Page number (0-indexed)
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
        - name: per_page
          in: query
          description: Number of items per page
          required: false
          schema:
            type: integer
            format: int32
            maximum: 100
            minimum: 1
      responses:
        '200':
          description: List of batch jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    BatchJobListResponse:
      type: object
      required:
        - data
        - pagination_meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BatchJobResponse'
        pagination_meta:
          $ref: '#/components/schemas/PaginationResponse'
    RestErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
    BatchJobResponse:
      type: object
      required:
        - id
        - job_type
        - status
        - processed_items
        - failed_items
        - created_by
        - created_at
      properties:
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        created_by:
          type: string
          format: uuid
        failed_items:
          type: integer
          format: int32
        id:
          $ref: '#/components/schemas/BatchJobId'
        input_file_name:
          type:
            - string
            - 'null'
        job_type:
          $ref: '#/components/schemas/BatchJobType'
        processed_items:
          type: integer
          format: int32
        status:
          $ref: '#/components/schemas/BatchJobStatus'
        total_items:
          type:
            - integer
            - 'null'
          format: int32
    PaginationResponse:
      type: object
      required:
        - page
        - per_page
        - total_items
        - total_pages
      properties:
        page:
          type: integer
          format: int32
          minimum: 0
        per_page:
          type: integer
          format: int32
          minimum: 0
        total_items:
          type: integer
          format: int64
          minimum: 0
        total_pages:
          type: integer
          format: int32
          minimum: 0
    ErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - NOT_FOUND
        - CONFLICT
        - FORBIDDEN
        - UNAUTHORIZED
        - TOO_MANY_REQUESTS
        - INTERNAL_SERVER_ERROR
    BatchJobId:
      type: string
      format: MeteroidId
      examples:
        - bjob_7n42DGM5Tflk9n8mt7Fhc7
    BatchJobType:
      type: string
      title: BatchJobType
      enum:
        - EVENT_CSV_IMPORT
        - CUSTOMER_CSV_IMPORT
        - SUBSCRIPTION_CSV_IMPORT
        - SUBSCRIPTION_PLAN_MIGRATION
    BatchJobStatus:
      type: string
      title: BatchJobStatus
      enum:
        - PENDING
        - CHUNKING
        - PROCESSING
        - COMPLETED
        - COMPLETED_WITH_ERRORS
        - FAILED
        - CANCELLED
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````