Fundraising
Preview stewardship relationship provisioning
Requires stewardship_relationship_groups_v1 and unrestricted donor-form visibility. Reads enabled reciprocal relationship mappings and soft-credit evidence, returning available/blocked/review candidates with a policy/evidence fingerprint. Does not create groups. Requires permission: one of donors_view.
GET
/
admin
/
fundraising
/
relationship-provisioning
/
preview
Preview stewardship relationship provisioning
curl --request GET \
--url https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview"
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/fundraising/relationship-provisioning/preview', 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/relationship-provisioning/preview",
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/relationship-provisioning/preview"
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))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview")
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": {
"enabled": true,
"policy_version": 2,
"default_giving_scope": "Example",
"fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"summary": {
"total": 2,
"returned": 2,
"selected": 2,
"review": 2,
"needs_mapping": 2,
"blocked": 2,
"already_active": 2,
"deactivated": 2
},
"candidates": [
{
"candidate_key": "Example",
"status": "available",
"confidence": "high",
"recommended_action": "create",
"selected_by_default": true,
"blockers": [
"<string>"
],
"core": {
"id": 42,
"name": "Example",
"subject_type": "donor"
},
"mapped_vehicles": [
{
"id": 42,
"household_id": 42,
"name": "Example",
"email": "Example",
"is_organization": true,
"is_archived": true,
"rule_keys": [
"<string>"
],
"relationship_evidence": [
{
"forward_id": 42,
"reverse_id": 42,
"core_relationship_type": "Example",
"vehicle_relationship_type": "Example"
}
],
"soft_credit": {},
"giving_scope": "Example"
}
],
"evidence_only_vehicles": [
{
"id": 42,
"household_id": 42,
"name": "Example",
"email": "Example",
"is_organization": true,
"is_archived": true,
"rule_keys": [
"<string>"
],
"relationship_evidence": [
{
"forward_id": 42,
"reverse_id": 42,
"core_relationship_type": "Example",
"vehicle_relationship_type": "Example"
}
],
"soft_credit": {},
"giving_scope": "Example"
}
],
"mapped_vehicle_count": 2,
"evidence_only_vehicle_count": 2,
"giving_scope": "Example",
"evidence": {
"rule_keys": [
"<string>"
],
"relationship_evidence": [
{}
],
"soft_credit": {
"gift_count": 2,
"attributed_amount": 25,
"soft_credit_type_keys": [
"<string>"
],
"policy_basis": [
"<string>"
]
}
},
"proposed_group": {
"kind": "Example",
"display_name": "Example",
"core_subject_type": "Example",
"core_subject_id": 42,
"assigned_fundraiser_user_id": 42,
"links": [
{
"id": 42,
"household_id": 42,
"name": "Example",
"email": "Example",
"is_organization": true,
"is_archived": true,
"link_id": 42,
"role": "giving_vehicle",
"giving_scope": "attributed_only",
"expects_attribution": true,
"is_primary_contact": true,
"collapse_in_portfolio": true,
"relationship_label": "Example",
"legal_lifetime_giving": 25,
"legal_ytd_giving": 25,
"legal_gift_count": 2
}
]
}
}
],
"truncated": true,
"selection_limited": true,
"selection_limit": 2
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}⌘I
Preview stewardship relationship provisioning
curl --request GET \
--url https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview"
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/fundraising/relationship-provisioning/preview', 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/relationship-provisioning/preview",
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/relationship-provisioning/preview"
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))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/fundraising/relationship-provisioning/preview")
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": {
"enabled": true,
"policy_version": 2,
"default_giving_scope": "Example",
"fingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"summary": {
"total": 2,
"returned": 2,
"selected": 2,
"review": 2,
"needs_mapping": 2,
"blocked": 2,
"already_active": 2,
"deactivated": 2
},
"candidates": [
{
"candidate_key": "Example",
"status": "available",
"confidence": "high",
"recommended_action": "create",
"selected_by_default": true,
"blockers": [
"<string>"
],
"core": {
"id": 42,
"name": "Example",
"subject_type": "donor"
},
"mapped_vehicles": [
{
"id": 42,
"household_id": 42,
"name": "Example",
"email": "Example",
"is_organization": true,
"is_archived": true,
"rule_keys": [
"<string>"
],
"relationship_evidence": [
{
"forward_id": 42,
"reverse_id": 42,
"core_relationship_type": "Example",
"vehicle_relationship_type": "Example"
}
],
"soft_credit": {},
"giving_scope": "Example"
}
],
"evidence_only_vehicles": [
{
"id": 42,
"household_id": 42,
"name": "Example",
"email": "Example",
"is_organization": true,
"is_archived": true,
"rule_keys": [
"<string>"
],
"relationship_evidence": [
{
"forward_id": 42,
"reverse_id": 42,
"core_relationship_type": "Example",
"vehicle_relationship_type": "Example"
}
],
"soft_credit": {},
"giving_scope": "Example"
}
],
"mapped_vehicle_count": 2,
"evidence_only_vehicle_count": 2,
"giving_scope": "Example",
"evidence": {
"rule_keys": [
"<string>"
],
"relationship_evidence": [
{}
],
"soft_credit": {
"gift_count": 2,
"attributed_amount": 25,
"soft_credit_type_keys": [
"<string>"
],
"policy_basis": [
"<string>"
]
}
},
"proposed_group": {
"kind": "Example",
"display_name": "Example",
"core_subject_type": "Example",
"core_subject_id": 42,
"assigned_fundraiser_user_id": 42,
"links": [
{
"id": 42,
"household_id": 42,
"name": "Example",
"email": "Example",
"is_organization": true,
"is_archived": true,
"link_id": 42,
"role": "giving_vehicle",
"giving_scope": "attributed_only",
"expects_attribution": true,
"is_primary_contact": true,
"collapse_in_portfolio": true,
"relationship_label": "Example",
"legal_lifetime_giving": 25,
"legal_ytd_giving": 25,
"legal_gift_count": 2
}
]
}
}
],
"truncated": true,
"selection_limited": true,
"selection_limit": 2
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}