List fundraising caseload

GET

admin

fundraising

caseload

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

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

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

	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/fundraising/caseload")

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

{
  "status": "success",
  "data": {
    "items": [
      {
        "portfolio_subject_type": "Example",
        "portfolio_subject_id": 2,
        "relationship_group_id": 2,
        "donor_id": 2,
        "donor_name": "Example",
        "email": "Example",
        "phone": "Example",
        "street": "Example",
        "address_line2": "Example",
        "city": "Example",
        "state": "Example",
        "zip": "Example",
        "household_id": 2,
        "household_name": "Example",
        "household_primary_contact_id": 2,
        "household_size": 2,
        "household_member_names": [
          "Example"
        ],
        "assigned_fundraiser_user_id": 2,
        "assigned_fundraiser_name": "Example",
        "donor_assigned_fundraiser_user_id": 2,
        "household_assigned_fundraiser_user_id": 2,
        "assignment_scope": "Example",
        "lifetime_total": 25,
        "direct_lifetime_giving": 25,
        "soft_credit_lifetime_giving": 25,
        "first_gift_date": "2026-10-20",
        "last_gift_date": "2026-10-20",
        "last_gift_amount": 25,
        "last_gift_source": "Example",
        "last_gift_source_id": 2,
        "last_gift_legal_donor_id": 2,
        "last_gift_legal_donor_name": "Example",
        "last_gift_soft_credit_type_key": "Example",
        "largest_gift": 25,
        "largest_gift_date": "2026-10-20",
        "average_gift": 25,
        "total_gifts": 2,
        "direct_total_gifts": 2,
        "soft_credit_total_gifts": 2,
        "current_period_gift_count": 2,
        "comparison_period_gift_count": 2,
        "ytd_giving": 25,
        "direct_ytd_giving": 25,
        "soft_credit_ytd_giving": 25,
        "previous_ytd_giving": 25,
        "last_year_giving": 25,
        "year_before_giving": 25,
        "giving_trend": 25,
        "trend_status": "Example",
        "giving_basis": "Example",
        "donor_segment": "Example",
        "retention_status": "Example",
        "is_deceased": true,
        "last_interaction_date": "2026-10-20",
        "last_touch_at": "2026-10-20T12:00:00Z",
        "last_meaningful_touch_at": "2026-10-20T12:00:00Z",
        "next_scheduled_touch_at": "2026-10-20T12:00:00Z",
        "days_since_contact": 2,
        "contact_status": "Example",
        "recorded_interactions": 2,
        "total_interactions": 2,
        "contact_count": 2,
        "meaningful_interactions": 2,
        "meaningful_contact_count": 2,
        "engagement_rate": 25,
        "at_risk": true,
        "lapsed": true,
        "upgrade_potential": true,
        "needs_contact": true,
        "risk_reasons": [
          "Example"
        ],
        "open_work_items": 2,
        "comparison_year": 2,
        "relationship_manager_user_id": 2,
        "relationship_manager_name": "Example",
        "donor_relationship_manager_user_id": 2,
        "household_relationship_manager_user_id": 2,
        "plan_summary": {
          "id": 42,
          "version": 2,
          "subject": {
            "type": "donor",
            "id": 42
          },
          "stage": "qualifying",
          "status": "draft",
          "tier": "A",
          "stage_entered_at": "2026-10-20T12:00:00Z",
          "action_donor_id": 42,
          "period": {
            "start": "2026-10-20",
            "end": "2026-10-20"
          },
          "currency": "USD",
          "goal_amount": 1000,
          "attributed_actual": 1000,
          "direct_actual": 1000,
          "soft_credit_actual": 1000,
          "variance_amount": 1000,
          "gift_count": 2,
          "giving_status": "pending",
          "giving_last_successful_at": "2026-10-20T12:00:00Z",
          "currency_breakdown": [
            {
              "currency": "Example",
              "attributed_actual": 1000,
              "direct_actual": 1000,
              "soft_credit_actual": 1000,
              "gift_count": 2
            }
          ],
          "next_move": {
            "id": 42,
            "title": "Example",
            "planned_at": "2026-10-20T12:00:00Z"
          },
          "open_move_count": 2,
          "overdue_move_count": 2,
          "health": {
            "status": "Example",
            "reasons": [
              "overdue_move"
            ]
          },
          "metric_basis": "relationship_attribution"
        }
      }
    ],
    "pagination": {
      "total": 2,
      "per_page": 2,
      "current_page": 2,
      "last_page": 2
    },
    "summary": {
      "total": 2,
      "at_risk": 2,
      "lapsed": 2,
      "upgrade_potential": 2,
      "needs_contact": 2,
      "unassigned": 2,
      "lifetime_total": 25,
      "ytd_giving": 25
    },
    "projection": {
      "status": "Example",
      "ready": true,
      "projection_version": 2,
      "required_projection_version": 2,
      "started_at": "2026-10-20T12:00:00Z",
      "completed_at": "2026-10-20T12:00:00Z",
      "last_reconciled_at": "2026-10-20T12:00:00Z",
      "calculated_for_date": "2026-10-20",
      "last_error": "Example"
    },
    "trend_context": {
      "basis": "Example",
      "mode": "Example",
      "follows_selected_comparison": true,
      "formula": "Example",
      "current": {
        "start": "2026-10-20",
        "end": "2026-10-20",
        "label": "Example"
      },
      "comparison": {
        "start": "2026-10-20",
        "end": "2026-10-20",
        "label": "Example"
      }
    },
    "search": {
      "candidate_count": 2,
      "estimated_hits": 2,
      "truncated": true,
      "fallback": "Example"
    },
    "planning_summary": {
      "managed_count": 2,
      "qualifying_count": 2,
      "no_next_move_count": 2,
      "overdue_move_count": 2,
      "currencies": [
        {
          "currency": "Example",
          "goal_amount": 25,
          "attributed_actual": 25,
          "remaining_amount": 25,
          "currency_mismatch_plan_count": 2
        }
      ]
    },
    "plan_currencies": [
      "USD"
    ]
  }
}

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

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

{
  "success": false,
  "error_code": "FUNDRAISING_PORTFOLIO_PROJECTION_INITIALIZING",
  "message": "<string>",
  "projection": {
    "status": "Example",
    "ready": true,
    "projection_version": 2,
    "required_projection_version": 2,
    "started_at": "2026-10-20T12:00:00Z",
    "completed_at": "2026-10-20T12:00:00Z",
    "last_reconciled_at": "2026-10-20T12:00:00Z",
    "calculated_for_date": "2026-10-20",
    "last_error": "Example"
  }
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

acknowledgement_work_scope

enum<string> | null

Acknowledgement work scope. Validation: nullable; allowed values: active, historical, all.

Available options:

active,

historical,

all,

null

fundraiser_user_id

string | null

Relationship-manager id, all or unassigned; scoped by donor visibility.

Maximum string length: 64

group_by_household

boolean | null

Boolean-like query input; true/false and numeric forms are normalized by this workflow.

string | null

Search. Validation: nullable, string, max:255.

Maximum string length: 255

date_from

string<date-time> | null

Date from. Validation: nullable, date.

date_to

string<date-time> | null

Date to. Validation: nullable, date.

state

string | null

State. Validation: nullable, string, max:64.

Maximum string length: 64

comparison_mode

string | null

Comparison mode. Validation: nullable, string, max:64.

Maximum string length: 64

current_start

string<date-time> | null

Current start. Validation: nullable, date.

current_end

string<date-time> | null

Current end. Validation: nullable, date.

comparison_start

string<date-time> | null

Comparison start. Validation: nullable, date.

comparison_end

string<date-time> | null

Comparison end. Validation: nullable, date.

refresh

boolean | null

Boolean-like query input; true/false and numeric forms are normalized by this workflow.

page

integer | null

Page. Validation: nullable, integer, min:1.

Required range: x >= 1

per_page

integer | null

Per page. Validation: nullable, integer, min:10, max:100.

Required range: 10 <= x <= 100

segment

string | null

Segment. Validation: nullable, string, max:64.

Maximum string length: 64

status

string | null

Status. Validation: nullable, string, max:64.

Maximum string length: 64

portfolio_view

enum<string> | null

Portfolio view. Validation: nullable; allowed values: managed, qualifying, all.

Available options:

managed,

qualifying,

all,

null

plan_period

string | null

Plan period. Validation: nullable, string, regex:/^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$/.

Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

plan_currency

string | null

Plan currency. Validation: nullable, string, max:3.

Maximum string length: 3

tier

enum<string> | null

Tier. Validation: nullable; allowed values: all, A, B, C, unset.

Available options:

all,

A,

B,

C,

unset,

null

plan_health

enum<string> | null

Plan health. Validation: nullable; allowed values: all, on_track, needs_attention, at_risk, draft, paused, complete, no_plan.

Available options:

all,

on_track,

needs_attention,

at_risk,

draft,

paused,

complete,

no_plan,

null

next_move

enum<string> | null

Next move. Validation: nullable; allowed values: all, overdue, none, scheduled.

Available options:

all,

overdue,

none,

scheduled,

null

sort_field

enum<string> | null

Sort field. Validation: nullable, string; allowed values: donor_name, lifetime_total, last_gift_date, days_since_contact, giving_trend, ytd_giving.

Available options:

donor_name,

lifetime_total,

last_gift_date,

days_since_contact,

giving_trend,

ytd_giving,

null

sort_direction

enum<string> | null

Sort direction. Validation: nullable; allowed values: asc, desc.

Available options:

asc,

desc,

null

Response

Operation result.

status

string

Example:

"success"

data

object

Page of ready portfolio facts. Planning summary/currencies appear only with the stewardship-plan feature. Search reports whether candidate matching was truncated.

Show child attributes

List fundraising caseload

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

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

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

	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/fundraising/caseload")

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

{
  "status": "success",
  "data": {
    "items": [
      {
        "portfolio_subject_type": "Example",
        "portfolio_subject_id": 2,
        "relationship_group_id": 2,
        "donor_id": 2,
        "donor_name": "Example",
        "email": "Example",
        "phone": "Example",
        "street": "Example",
        "address_line2": "Example",
        "city": "Example",
        "state": "Example",
        "zip": "Example",
        "household_id": 2,
        "household_name": "Example",
        "household_primary_contact_id": 2,
        "household_size": 2,
        "household_member_names": [
          "Example"
        ],
        "assigned_fundraiser_user_id": 2,
        "assigned_fundraiser_name": "Example",
        "donor_assigned_fundraiser_user_id": 2,
        "household_assigned_fundraiser_user_id": 2,
        "assignment_scope": "Example",
        "lifetime_total": 25,
        "direct_lifetime_giving": 25,
        "soft_credit_lifetime_giving": 25,
        "first_gift_date": "2026-10-20",
        "last_gift_date": "2026-10-20",
        "last_gift_amount": 25,
        "last_gift_source": "Example",
        "last_gift_source_id": 2,
        "last_gift_legal_donor_id": 2,
        "last_gift_legal_donor_name": "Example",
        "last_gift_soft_credit_type_key": "Example",
        "largest_gift": 25,
        "largest_gift_date": "2026-10-20",
        "average_gift": 25,
        "total_gifts": 2,
        "direct_total_gifts": 2,
        "soft_credit_total_gifts": 2,
        "current_period_gift_count": 2,
        "comparison_period_gift_count": 2,
        "ytd_giving": 25,
        "direct_ytd_giving": 25,
        "soft_credit_ytd_giving": 25,
        "previous_ytd_giving": 25,
        "last_year_giving": 25,
        "year_before_giving": 25,
        "giving_trend": 25,
        "trend_status": "Example",
        "giving_basis": "Example",
        "donor_segment": "Example",
        "retention_status": "Example",
        "is_deceased": true,
        "last_interaction_date": "2026-10-20",
        "last_touch_at": "2026-10-20T12:00:00Z",
        "last_meaningful_touch_at": "2026-10-20T12:00:00Z",
        "next_scheduled_touch_at": "2026-10-20T12:00:00Z",
        "days_since_contact": 2,
        "contact_status": "Example",
        "recorded_interactions": 2,
        "total_interactions": 2,
        "contact_count": 2,
        "meaningful_interactions": 2,
        "meaningful_contact_count": 2,
        "engagement_rate": 25,
        "at_risk": true,
        "lapsed": true,
        "upgrade_potential": true,
        "needs_contact": true,
        "risk_reasons": [
          "Example"
        ],
        "open_work_items": 2,
        "comparison_year": 2,
        "relationship_manager_user_id": 2,
        "relationship_manager_name": "Example",
        "donor_relationship_manager_user_id": 2,
        "household_relationship_manager_user_id": 2,
        "plan_summary": {
          "id": 42,
          "version": 2,
          "subject": {
            "type": "donor",
            "id": 42
          },
          "stage": "qualifying",
          "status": "draft",
          "tier": "A",
          "stage_entered_at": "2026-10-20T12:00:00Z",
          "action_donor_id": 42,
          "period": {
            "start": "2026-10-20",
            "end": "2026-10-20"
          },
          "currency": "USD",
          "goal_amount": 1000,
          "attributed_actual": 1000,
          "direct_actual": 1000,
          "soft_credit_actual": 1000,
          "variance_amount": 1000,
          "gift_count": 2,
          "giving_status": "pending",
          "giving_last_successful_at": "2026-10-20T12:00:00Z",
          "currency_breakdown": [
            {
              "currency": "Example",
              "attributed_actual": 1000,
              "direct_actual": 1000,
              "soft_credit_actual": 1000,
              "gift_count": 2
            }
          ],
          "next_move": {
            "id": 42,
            "title": "Example",
            "planned_at": "2026-10-20T12:00:00Z"
          },
          "open_move_count": 2,
          "overdue_move_count": 2,
          "health": {
            "status": "Example",
            "reasons": [
              "overdue_move"
            ]
          },
          "metric_basis": "relationship_attribution"
        }
      }
    ],
    "pagination": {
      "total": 2,
      "per_page": 2,
      "current_page": 2,
      "last_page": 2
    },
    "summary": {
      "total": 2,
      "at_risk": 2,
      "lapsed": 2,
      "upgrade_potential": 2,
      "needs_contact": 2,
      "unassigned": 2,
      "lifetime_total": 25,
      "ytd_giving": 25
    },
    "projection": {
      "status": "Example",
      "ready": true,
      "projection_version": 2,
      "required_projection_version": 2,
      "started_at": "2026-10-20T12:00:00Z",
      "completed_at": "2026-10-20T12:00:00Z",
      "last_reconciled_at": "2026-10-20T12:00:00Z",
      "calculated_for_date": "2026-10-20",
      "last_error": "Example"
    },
    "trend_context": {
      "basis": "Example",
      "mode": "Example",
      "follows_selected_comparison": true,
      "formula": "Example",
      "current": {
        "start": "2026-10-20",
        "end": "2026-10-20",
        "label": "Example"
      },
      "comparison": {
        "start": "2026-10-20",
        "end": "2026-10-20",
        "label": "Example"
      }
    },
    "search": {
      "candidate_count": 2,
      "estimated_hits": 2,
      "truncated": true,
      "fallback": "Example"
    },
    "planning_summary": {
      "managed_count": 2,
      "qualifying_count": 2,
      "no_next_move_count": 2,
      "overdue_move_count": 2,
      "currencies": [
        {
          "currency": "Example",
          "goal_amount": 25,
          "attributed_actual": 25,
          "remaining_amount": 25,
          "currency_mismatch_plan_count": 2
        }
      ]
    },
    "plan_currencies": [
      "USD"
    ]
  }
}

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

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

{
  "success": false,
  "error_code": "FUNDRAISING_PORTFOLIO_PROJECTION_INITIALIZING",
  "message": "<string>",
  "projection": {
    "status": "Example",
    "ready": true,
    "projection_version": 2,
    "required_projection_version": 2,
    "started_at": "2026-10-20T12:00:00Z",
    "completed_at": "2026-10-20T12:00:00Z",
    "last_reconciled_at": "2026-10-20T12:00:00Z",
    "calculated_for_date": "2026-10-20",
    "last_error": "Example"
  }
}