Files

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.

GET

admin

bulk-edit-operations

{operationId}

Get bulk operation progress

curl --request GET \
  --url https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "operation_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "donors",
    "status": "completed_with_errors",
    "message": "Bulk operation completed with errors.",
    "stalled": false,
    "has_failed_records": true,
    "failed_record_ids": [
      123
    ],
    "failed_records": [
      {
        "id": 42,
        "label": "Jane Donor"
      }
    ],
    "failed_records_pagination": {
      "page": 1,
      "per_page": 100,
      "total": 2,
      "last_page": 1,
      "has_more": false
    },
    "skipped_reasons": {},
    "context": {},
    "retry_selection": {
      "selection_mode": "failed_operation",
      "failed_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "selected_count": 2,
      "event_id": 42
    },
    "total_items": 2,
    "processed_items": 2,
    "failed_items": 2,
    "skipped_items": 2,
    "updated_items": 2,
    "progress_percent": 2,
    "created_at": "2026-10-20T10:00:00Z",
    "updated_at": "2026-10-20T10:00:00Z",
    "completed_at": "2026-10-20T10:00:00Z"
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

operationId

string<uuid>

required

Bulk operation UUID returned when the workflow was queued.

Query Parameters

failed_page

integer | null

Failure page, default1.

Required range: x >= 1

failed_page_size

integer | null

Failures per page, default/max100.

Required range: 1 <= x <= 100

Response

Operation result.

data

object

Show child attributes

Get bulk operation progress

curl --request GET \
  --url https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/bulk-edit-operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "operation_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "donors",
    "status": "completed_with_errors",
    "message": "Bulk operation completed with errors.",
    "stalled": false,
    "has_failed_records": true,
    "failed_record_ids": [
      123
    ],
    "failed_records": [
      {
        "id": 42,
        "label": "Jane Donor"
      }
    ],
    "failed_records_pagination": {
      "page": 1,
      "per_page": 100,
      "total": 2,
      "last_page": 1,
      "has_more": false
    },
    "skipped_reasons": {},
    "context": {},
    "retry_selection": {
      "selection_mode": "failed_operation",
      "failed_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "selected_count": 2,
      "event_id": 42
    },
    "total_items": 2,
    "processed_items": 2,
    "failed_items": 2,
    "skipped_items": 2,
    "updated_items": 2,
    "progress_percent": 2,
    "created_at": "2026-10-20T10:00:00Z",
    "updated_at": "2026-10-20T10:00:00Z",
    "completed_at": "2026-10-20T10:00:00Z"
  }
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Not Found",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}