Read a fundraising household profile

curl --request GET \
  --url https://api.gratona.com/v1/admin/fundraising/portfolio/household/{household_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/fundraising/portfolio/household/{household_id}"

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/portfolio/household/{household_id}', 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/portfolio/household/{household_id}",
  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/portfolio/household/{household_id}"

	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/portfolio/household/{household_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/fundraising/portfolio/household/{household_id}")

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": {
    "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,
    "do_not_email": true,
    "action_donors": [
      {
        "id": 42,
        "display_name": "Example",
        "email": "Example",
        "do_not_email": true,
        "status": "Example",
        "role": "Example",
        "relationship_label": "Example",
        "is_primary_contact": true
      }
    ],
    "household_members": [
      {
        "id": 42,
        "name": "Example",
        "email": "Example"
      }
    ],
    "relationship": {
      "id": 42,
      "kind": "family_fund",
      "display_name": "Example",
      "core_subject_type": "donor",
      "core_subject_id": 42,
      "representative_donor_id": 42,
      "assigned_fundraiser_user_id": 42,
      "is_active": true,
      "origin": "manual",
      "provisioning_key": "Example",
      "provisioning_evidence": {},
      "core_members": [
        {
          "id": 42,
          "household_id": 42,
          "name": "Example",
          "email": "Example",
          "is_organization": true,
          "is_archived": true
        }
      ],
      "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
        }
      ],
      "data_quality": {
        "core_available": true,
        "core_issue": "Example",
        "count": 2,
        "amount": 25,
        "gift_amount": 25,
        "items": [
          {
            "donation_id": 42,
            "date": "2026-10-20",
            "amount": 25,
            "missing_attribution_amount": 25,
            "existing_attribution_amount": 25,
            "currency": "Example",
            "legal_donor_name": "Example"
          }
        ]
      },
      "current_donor_role": "Example",
      "current_link_id": 42,
      "warnings": [
        {
          "code": "Example",
          "message": "Example"
        }
      ]
    },
    "transactions": [
      {
        "id": 2,
        "donor_id": 2,
        "donor_name": "Example",
        "donor_email": "Example",
        "amount": 25,
        "gross_amount": 25,
        "currency": "Example",
        "date": "2026-10-20",
        "method": "Example",
        "method_id": 3,
        "method_detail": {
          "provider": "Example",
          "provider_label": "Example",
          "source_method": "Example",
          "source_processor": "Example"
        },
        "type": "Example",
        "result": "Example",
        "transaction_status": "Example",
        "acknowledged": "Example",
        "acknowledgement_excluded": "Example",
        "acknowledged_at": "2026-10-20T12:00:00Z",
        "acknowledged_by_user_id": 2,
        "acknowledgement_source": "Example",
        "assigned_fundraiser_name": "Example",
        "city": "Example",
        "state": "Example",
        "relationship_manager_name": "Example"
      }
    ],
    "attributed_gifts": [
      {
        "source_gift_id": 42,
        "legal_donor_id": 42,
        "donor_id": 42,
        "relationship_group_id": 42,
        "id": "direct:42",
        "soft_credit_ids": [
          42
        ],
        "amount": 25,
        "currency": "Example",
        "date": "2026-10-20",
        "attribution_source": "Example",
        "source_donor_name": "Example",
        "soft_credit_type": "Example",
        "soft_credit_type_key": "Example",
        "relationship_role": "Example",
        "exclusion_reason": "Example",
        "notes": "Example",
        "policy_basis": [
          "<string>"
        ],
        "counts_toward_attributed_giving": true
      }
    ],
    "interactions": [
      {
        "id": "activity:42",
        "donor_id": 2,
        "donor_name": "Example",
        "donor_email": "Example",
        "date": "2026-10-20",
        "channel": "Example",
        "purpose": "Example",
        "subject": "Example",
        "note": "Example",
        "is_contact": true,
        "is_meaningful": true,
        "meaningful_basis": "Example",
        "owner_name": "Example",
        "assigned_fundraiser_name": "Example",
        "city": "Example",
        "state": "Example",
        "relationship_manager_name": "Example"
      }
    ],
    "projection_refresh_pending": true,
    "warnings": [
      {
        "code": "Example",
        "message": "Example"
      }
    ]
  }
}

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

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

{
  "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"
  }
}