Donations

Get a donation worksheet with query filters

GET variant of the donation worksheet, with the same organization/form scope and tab-specific projection as POST. Date defaults use organization time. Saved views fill omitted filters/columns and date presets. Search, filtering and sorting use the registered field contracts; totals and graphs can be skipped with includeSummary=false. Supplying report_name creates a saved report even through GET, so omit it for a read-only request. Prefer POST for large nested filter/column payloads. Requires permission: one of donations, reports_view, reports_manage.

GET

admin

donations

curl --request GET \
  --url https://api.gratona.com/v1/admin/donations \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.gratona.com/v1/admin/donations', 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/donations",
  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/donations"

	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/donations")

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

{
  "donations": [
    {
      "donation_id": 42,
      "donor_id": 21,
      "amount": "25.00",
      "actual_amount_charged": "25.00",
      "currency": "$",
      "failed": false,
      "transaction_status": "completed",
      "profile": {},
      "entity_profile": {},
      "donor": {},
      "designation": {},
      "method": "Check",
      "method_id": 1,
      "refunded_amount": "0.00",
      "date": "2026-10-20T12:00:00Z",
      "acknowledged": false,
      "acknowledgement": "Unacknowledged",
      "giving_source": "direct",
      "soft_credits": [
        {
          "id": 42,
          "donor_id": 24,
          "donor_name": "Jane Donor",
          "amount": "25.00",
          "type": "In Honor Of",
          "notes": "Community introduction"
        }
      ]
    }
  ],
  "soft_credit_donations": [
    {}
  ],
  "organization": "Example Nonprofit",
  "client": {
    "id": 207,
    "organization": "Gratona Demo Org",
    "website": "https://demo.gratona.com",
    "email": "hello@demo.gratona.com",
    "stripe_connect_id": "acct_1OqXXXXX",
    "previous_stripe_connect_id": null,
    "completed_stripe_onboarding": true,
    "date_format": "Y-m-d",
    "timezone": "America/Chicago",
    "custom": {},
    "frequency": {},
    "custom_start_date": null,
    "custom_amount": null,
    "created_at": "2024-06-01T12:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "number_of_allDonations": 25,
  "number_of_donations": 10,
  "total_of_donations": "625",
  "soft_credit_stats": {},
  "soft_credit_graph_data": [
    {}
  ],
  "donation_graph_data": [
    {}
  ],
  "fields": [
    {
      "field_key": "gift_example",
      "field_label": "Campaign source",
      "field_type": "hysText",
      "field_group": "Donation Form Fields"
    }
  ],
  "date_from": "2026-09-20",
  "date_to": "2026-10-20",
  "program_totals": [
    {}
  ],
  "all": true,
  "hysform": {},
  "current_year": 2026,
  "last_year": 2025,
  "show_standardized_fields": true,
  "visible_standard_field_keys": [
    "first_name"
  ],
  "title_field_keys": [
    "first_name"
  ],
  "standard_title_field_keys": [
    "first_name"
  ],
  "sort": {
    "key": "amount",
    "order": "desc"
  },
  "applied_filters": {}
}

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

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

selectedTab

enum<string>

required

Worksheet mode; controls row and aggregate semantics.

Available options:

Donations,

Refunds,

Failed,

Soft Credits

Donor_Group

Donor form within the current organization, or all forms. Required unless all=true; saved views do not fill this field.

Example:

42

all

boolean

Include every donor form; also enabled by Donor_Group=all.

date_from

string<date>

Inclusive creation-date start; default30 days before today when both dates are omitted. Refund occurrence mode uses refund date instead.

date_to

string<date>

Inclusive end date; default today. A single supplied date is used for both bounds.

pageSize

integer

Requested page size; default10.

pageIndex

integer

One-based worksheet page; default1.

includeSummary

boolean

Default true. False skips expensive summary/statistics/graph work and returns zero or empty aggregates.

include_summary

boolean

Compatibility alias for includeSummary.

query

string

Search across allowed donation/recognition fields.

search_fields

string[]

Optional registered searchable field keys.

filterGroups

object[]

Ordered field predicates. Unsupported stale view fields are sanitized; invalid literal values can return422.

Show child attributes

filterKey

string

Single-filter field when filterGroups is absent.

filterOperator

string

Single-filter operator, default equals.

filterValue

Filter operand matching the field and operator. Multi-select operators accept arrays.

Example:

"Education"

sortKey

string

Registered donation or recognition sort key; unsupported keys are ignored.

sortOrder

enum<string>

Sort direction normalized by the sort-field contract.

Available options:

asc,

desc

sort_key

string

Compatibility alias for sortKey.

sort_order

string

Compatibility alias for sortOrder.

savedFilterId

integer

Organization-owned Donations saved view whose preferences fill omitted values.

saved_filter_id

integer

Compatibility alias for savedFilterId.

fields

Selected column keys as an array or JSON-encoded list. Controls related projections and response display flags.

in_kind

boolean | null

Restrict to in-kind gifts when true, or exclude them when false.

in_kind_category

string

Optional in-kind category filter.

sponsorship_type

Legacy one_time filter applied to displayed donation rows.

Example:

1

refund_occurred

boolean

For the Refunds tab, select by applied refund occurrence dates with a legacy updated_at fallback.

dateRange

Relative date range materialized in organization time; all_time starts1970-01-01.

Show child attributes

date_range

Compatibility alias for dateRange.

Show child attributes

report_name

string

Optional nonblank name creates a saved Report as a side effect. Supply fields when saving.

Response

Operation result.

The response also includes boolean display flags for selected built-in and standardized fields.

donations

object[]

Show child attributes

soft_credit_donations

object[]

organization

string

Example:

"Example Nonprofit"

client

Client · object

A Gratona client — the tenant of the multi-tenant system. Owns donors, entities, programs, users, and integrations. The client_id on every other resource scopes data to this row. Stripe Connect onboarding state, account-level settings, and the client's display name all live here.

Show child attributes

number_of_allDonations

integer

Filtered total row count for the current tab.

Example:

25

number_of_donations

integer

Rows on this page.

Example:

10

total_of_donations

Tab-dependent aggregate, or zero when summary is disabled.

Example:

"625"

soft_credit_stats

soft_credit_graph_data

object[]

donation_graph_data

object[]

fields

object[]

Show child attributes

date_from

string<date>

Example:

"2026-09-20"

date_to

string<date>

Example:

"2026-10-20"

program_totals

object[]

all

boolean

Example:

true

hysform

object

current_year

integer

Example:

2026

last_year

integer

Example:

2025

show_standardized_fields

boolean

Example:

true

visible_standard_field_keys

string[]

title_field_keys

string[]

standard_title_field_keys

string[]

sort

object

Show child attributes

applied_filters

object

Applied saved-view preferences when a saved filter is selected.

Get a donation worksheet with query filters

curl --request GET \
  --url https://api.gratona.com/v1/admin/donations \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.gratona.com/v1/admin/donations', 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/donations",
  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/donations"

	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/donations")

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

{
  "donations": [
    {
      "donation_id": 42,
      "donor_id": 21,
      "amount": "25.00",
      "actual_amount_charged": "25.00",
      "currency": "$",
      "failed": false,
      "transaction_status": "completed",
      "profile": {},
      "entity_profile": {},
      "donor": {},
      "designation": {},
      "method": "Check",
      "method_id": 1,
      "refunded_amount": "0.00",
      "date": "2026-10-20T12:00:00Z",
      "acknowledged": false,
      "acknowledgement": "Unacknowledged",
      "giving_source": "direct",
      "soft_credits": [
        {
          "id": 42,
          "donor_id": 24,
          "donor_name": "Jane Donor",
          "amount": "25.00",
          "type": "In Honor Of",
          "notes": "Community introduction"
        }
      ]
    }
  ],
  "soft_credit_donations": [
    {}
  ],
  "organization": "Example Nonprofit",
  "client": {
    "id": 207,
    "organization": "Gratona Demo Org",
    "website": "https://demo.gratona.com",
    "email": "hello@demo.gratona.com",
    "stripe_connect_id": "acct_1OqXXXXX",
    "previous_stripe_connect_id": null,
    "completed_stripe_onboarding": true,
    "date_format": "Y-m-d",
    "timezone": "America/Chicago",
    "custom": {},
    "frequency": {},
    "custom_start_date": null,
    "custom_amount": null,
    "created_at": "2024-06-01T12:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  "number_of_allDonations": 25,
  "number_of_donations": 10,
  "total_of_donations": "625",
  "soft_credit_stats": {},
  "soft_credit_graph_data": [
    {}
  ],
  "donation_graph_data": [
    {}
  ],
  "fields": [
    {
      "field_key": "gift_example",
      "field_label": "Campaign source",
      "field_type": "hysText",
      "field_group": "Donation Form Fields"
    }
  ],
  "date_from": "2026-09-20",
  "date_to": "2026-10-20",
  "program_totals": [
    {}
  ],
  "all": true,
  "hysform": {},
  "current_year": 2026,
  "last_year": 2025,
  "show_standardized_fields": true,
  "visible_standard_field_keys": [
    "first_name"
  ],
  "title_field_keys": [
    "first_name"
  ],
  "standard_title_field_keys": [
    "first_name"
  ],
  "sort": {
    "key": "amount",
    "order": "desc"
  },
  "applied_filters": {}
}

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

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