> ## 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 bulk operation progress

> Returns an organization-visible bulk operation, including progress and paginated failed-record labels. Any authorized admin in the same organization may view it. failed_record_ids is a compatibility sample of at most100 and is empty for event invitations; use failed_records_pagination for the complete failure list. retry_selection is returned only for failed/completed-with-errors commitment or invitation operations whose persisted failure identities are complete. Requires permission: one of groups, admins, forms, manage_programs, programs_view, donors_view, donations, manage_email, email_manager, manage_sms, sms_manager, sms_inbox_view, sms_inbox_reply, sms_inbox_manage, sendblue_manage, mailings_view, mailings_generate, mailings_manage, manage_settings, access_account_settings, access_payment_gateways, tasks_view, tasks_manage, trips_view, events_view, events_checkin, events_finance, events_reports, events_sponsor_manage, imports_view, activity_logs_view, households_view, notes_view, reports_view.



## OpenAPI

````yaml get /admin/bulk-edit-operations/{operationId}
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 commitment relationships, lifecycle transitions, and
      commitment-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: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/bulk-edit-operations/{operationId}:
    get:
      tags:
        - Files
      summary: Get bulk operation progress
      description: >-
        Returns an organization-visible bulk operation, including progress and
        paginated failed-record labels. Any authorized admin in the same
        organization may view it. failed_record_ids is a compatibility sample of
        at most100 and is empty for event invitations; use
        failed_records_pagination for the complete failure list. retry_selection
        is returned only for failed/completed-with-errors commitment or
        invitation operations whose persisted failure identities are complete.
        Requires permission: one of groups, admins, forms, manage_programs,
        programs_view, donors_view, donations, manage_email, email_manager,
        manage_sms, sms_manager, sms_inbox_view, sms_inbox_reply,
        sms_inbox_manage, sendblue_manage, mailings_view, mailings_generate,
        mailings_manage, manage_settings, access_account_settings,
        access_payment_gateways, tasks_view, tasks_manage, trips_view,
        events_view, events_checkin, events_finance, events_reports,
        events_sponsor_manage, imports_view, activity_logs_view,
        households_view, notes_view, reports_view.
      operationId: reference_Admin_BulkEditOperationController_show
      parameters:
        - name: operationId
          in: path
          description: Bulk operation UUID returned when the workflow was queued.
          required: true
          schema:
            type: string
            format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        - name: failed_page
          in: query
          description: Failure page, default1.
          required: false
          schema:
            type: integer
            minimum: 1
            nullable: true
          example: 1
        - name: failed_page_size
          in: query
          description: Failures per page, default/max100.
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            nullable: true
          example: 100
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/BulkEditStatusSnapshot'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The authenticated user lacks access to this workflow or its related
            records.
        '404':
          description: The operation is missing or belongs to another organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
      servers:
        - url: https://api.gratona.com/v1
          description: Gratona API
components:
  schemas:
    BulkEditStatusSnapshot:
      properties:
        operation_id:
          description: >-
            HTTP contracts traced from the deployed controller and delegated
            validation/serialization.
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        type:
          description: >-
            Bulk workflow type, such as donors, recipients, commitments or
            event_invitees.
          type: string
          example: donors
        status:
          type: string
          enum:
            - processing
            - completed
            - completed_with_errors
            - failed
          example: completed_with_errors
        message:
          type: string
          example: Bulk operation completed with errors.
          nullable: true
        stalled:
          description: True when a processing operation has no update for five minutes.
          type: boolean
          example: false
        has_failed_records:
          type: boolean
          example: true
        failed_record_ids:
          type: array
          items:
            type: integer
          maxItems: 100
        failed_records:
          type: array
          items:
            properties:
              id:
                type: integer
                example: 42
              label:
                type: string
                example: Jane Donor
            type: object
        failed_records_pagination:
          properties:
            page:
              type: integer
              example: 1
            per_page:
              type: integer
              example: 100
            total:
              type: integer
              example: 2
            last_page:
              type: integer
              example: 1
            has_more:
              type: boolean
              example: false
          type: object
        skipped_reasons:
          description: Skip reason counts, or an empty list.
          oneOf:
            - type: object
              additionalProperties:
                type: integer
            - type: array
              items: {}
              maxItems: 0
        context:
          description: Event invitation context; null for other types.
          oneOf:
            - type: object
              additionalProperties: true
            - type: array
              items: {}
              maxItems: 0
            - type: string
              enum:
                - null
              nullable: true
        retry_selection:
          properties:
            selection_mode:
              type: string
              example: failed_operation
            failed_operation_id:
              type: string
              format: uuid
            selected_count:
              type: integer
              example: 2
            event_id:
              description: Present for an event invitation retry.
              type: integer
              example: 42
          type: object
          nullable: true
        total_items:
          type: integer
          example: 2
        processed_items:
          type: integer
          example: 2
        failed_items:
          type: integer
          example: 2
        skipped_items:
          type: integer
          example: 2
        updated_items:
          type: integer
          example: 2
        progress_percent:
          type: integer
          example: 2
        created_at:
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        updated_at:
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        completed_at:
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
      type: object
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
    NotFoundResponse:
      title: NotFoundResponse
      description: >-
        Returned with HTTP 404 when a resource lookup misses (typically because
        the id doesn't exist OR is scoped to a different `client_id`). Note:
        many endpoints intentionally collapse 'not found' and 'forbidden' into a
        single 404 to avoid leaking which records exist in another tenant.
      required:
        - message
      properties:
        message:
          description: >-
            Human-readable message. Often a more specific string like `Donor not
            found` or `Trip not found`.
          type: string
          example: Not Found
        status:
          type: string
          example: error
      type: object
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object
  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.