Donors
List active households
Searches active organization households by partial name/address and exact primary contact. Returns household summaries plus organization email sets with their templates and linked program; summaries use current donor membership.
GET
/
admin
/
households
List active households
curl --request GET \
--url https://api.gratona.com/v1/admin/households \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/households"
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/households', 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/households",
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/households"
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/households")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/households")
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{
"success": true,
"total": 42,
"per_page": 42,
"current_page": 42,
"last_page": 42,
"households": [
{
"id": 42,
"name": "Doe household",
"primary_contact": {
"id": 42,
"name": "Jane Doe"
},
"address": {
"line1": "10 Main Street",
"line2": "Apt 2",
"city": "Kampala",
"state": "Central",
"postal_code": "00000",
"country": "Uganda"
},
"json_fields": {},
"donor_ids": [
42
],
"donor_count": 42,
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z"
}
],
"emailsets": [
{
"id": 42,
"client_id": 42,
"name": "General donor emails",
"from": "team@example.org",
"emailtemplates": [
{
"id": 42,
"client_id": 42,
"emailset_id": 42,
"trigger": "Example",
"schedule": "Example",
"to": "Example",
"subject": "Example",
"message": "Example",
"design": "Example",
"donation_type": "Example",
"disabled": 0,
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z"
}
],
"program": {
"id": 11,
"client_id": 207,
"name": "Child Sponsorship 2026",
"type": "Contribution",
"prefix": "CS-2026",
"link_id": null,
"hysform_id": 42,
"donor_hysform_id": 43,
"setting_id": 87,
"emailset_id": 14,
"smsset_id": null,
"lft": 1,
"rgt": 8,
"tree": 1,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-12-31T23:00:00Z",
"deleted_at": null
},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z"
}
]
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"success": false,
"message": "Failed to update household",
"error": "Unable to complete household change."
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Query Parameters
One-based page.
Example:
1
Rows per page; defaults 10 (not clamped by this controller).
Example:
10
Partial household search match.
Example:
"Doe"
Partial household name match.
Example:
"Doe"
Partial household city match.
Example:
"Kampala"
Partial household state match.
Example:
"Kampala"
Partial household postal_code match.
Example:
"Kampala"
Exact primary donor match.
Example:
42
Sort column; default created_at, unsupported choices fall back.
Available options:
name, created_at, updated_at Example:
"name"
Sort direction; default desc.
Available options:
asc, desc Example:
"asc"
Response
List active households completed.
⌘I
List active households
curl --request GET \
--url https://api.gratona.com/v1/admin/households \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/households"
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/households', 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/households",
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/households"
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/households")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/households")
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{
"success": true,
"total": 42,
"per_page": 42,
"current_page": 42,
"last_page": 42,
"households": [
{
"id": 42,
"name": "Doe household",
"primary_contact": {
"id": 42,
"name": "Jane Doe"
},
"address": {
"line1": "10 Main Street",
"line2": "Apt 2",
"city": "Kampala",
"state": "Central",
"postal_code": "00000",
"country": "Uganda"
},
"json_fields": {},
"donor_ids": [
42
],
"donor_count": 42,
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z"
}
],
"emailsets": [
{
"id": 42,
"client_id": 42,
"name": "General donor emails",
"from": "team@example.org",
"emailtemplates": [
{
"id": 42,
"client_id": 42,
"emailset_id": 42,
"trigger": "Example",
"schedule": "Example",
"to": "Example",
"subject": "Example",
"message": "Example",
"design": "Example",
"donation_type": "Example",
"disabled": 0,
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z"
}
],
"program": {
"id": 11,
"client_id": 207,
"name": "Child Sponsorship 2026",
"type": "Contribution",
"prefix": "CS-2026",
"link_id": null,
"hysform_id": 42,
"donor_hysform_id": 43,
"setting_id": 87,
"emailset_id": 14,
"smsset_id": null,
"lft": 1,
"rgt": 8,
"tree": 1,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-12-31T23:00:00Z",
"deleted_at": null
},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z"
}
]
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"success": false,
"message": "Failed to update household",
"error": "Unable to complete household change."
}