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

# Get list of all import batches (payments, donors, recipients)



## OpenAPI

````yaml get /admin/import/batches
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /admin/import/batches:
    get:
      tags:
        - Files
      summary: Get list of all import batches (payments, donors, recipients)
      operationId: b382c141aeee599813a5f217db26b3df
      parameters:
        - name: type
          in: query
          description: >-
            Filter by batch type (payments, donors, recipients, relationships,
            participation, all)
          required: false
          schema:
            type: string
            default: all
          example: entity
        - name: status
          in: query
          description: Filter by status (pending, processing, completed, failed, undone)
          required: false
          schema:
            type: string
          example: completed
        - name: program_id
          in: query
          description: Filter by program ID
          required: false
          schema:
            type: integer
          example: 42
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            type: integer
            default: 1
          example: 1
        - name: per_page
          in: query
          description: Number of items per page
          required: false
          schema:
            type: integer
            default: 20
          example: 20
      responses:
        '200':
          description: List of import batches
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                          example: 123
                        batch_type:
                          type: string
                          example: payments
                        status:
                          type: string
                          example: completed
                        progress:
                          type: integer
                          example: 100
                        total_rows:
                          type: integer
                          example: 1000
                        successful_rows:
                          type: integer
                          example: 950
                        failed_rows:
                          type: integer
                          example: 50
                        filename:
                          type: string
                          example: import.csv
                        import_type:
                          description: Only for donor/recipient batches
                          type: string
                          example: donors
                        program_name:
                          type: string
                          example: Program Name
                        created_at:
                          type: string
                          example: '2024-01-14T10:30:00Z'
                        completed_at:
                          type: string
                          example: '2024-01-14T10:35:00Z'
                        can_be_undone:
                          type: boolean
                          example: true
                        total_amount:
                          description: Only for payment batches
                          type: number
                          example: 5000
                        donation_count:
                          description: Only for payment batches
                          type: integer
                          example: 100
                        record_count:
                          description: Only for donor/recipient batches
                          type: integer
                          example: 50
                      type: object
                  current_page:
                    type: integer
                    example: 1
                  per_page:
                    type: integer
                    example: 20
                  total:
                    type: integer
                    example: 50
                type: object
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

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