> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml get /admin/households openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /admin/households: get: tags: - Donors summary: List active households description: >- 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. operationId: HouseholdController_index parameters: - name: page in: query description: One-based page. required: false schema: type: integer example: 1 example: 1 - name: per_page in: query description: Rows per page; defaults 10 (not clamped by this controller). required: false schema: type: integer example: 10 example: 10 - name: search in: query description: Partial household search match. required: false schema: type: string example: Doe example: Doe - name: name in: query description: Partial household name match. required: false schema: type: string example: Doe example: Doe - name: city in: query description: Partial household city match. required: false schema: type: string example: Kampala example: Kampala - name: state in: query description: Partial household state match. required: false schema: type: string example: Kampala example: Kampala - name: postal_code in: query description: Partial household postal_code match. required: false schema: type: string example: Kampala example: Kampala - name: primary_contact_id in: query description: Exact primary donor match. required: false schema: type: integer example: 42 example: 42 - name: sort_by in: query description: Sort column; default created_at, unsupported choices fall back. required: false schema: type: string enum: - name - created_at - updated_at example: name example: name - name: sort_dir in: query description: Sort direction; default desc. required: false schema: type: string enum: - asc - desc example: asc example: asc responses: '200': description: List active households completed. content: application/json: schema: properties: success: description: Query succeeded. type: boolean example: true total: description: Matching household count. type: integer example: 42 per_page: description: Rows per page. type: integer example: 42 current_page: description: Current page. type: integer example: 42 last_page: description: Last page. type: integer example: 42 households: type: array items: properties: id: description: Household ID. type: integer example: 42 name: description: Household name. type: string example: Doe household primary_contact: properties: id: description: Donor ID. type: integer example: 42 name: description: Resolved donor name. type: string example: Jane Doe type: object nullable: true address: properties: line1: description: Household line1. type: string maxLength: 255 example: 10 Main Street nullable: true line2: description: Household line2. type: string maxLength: 255 example: Apt 2 nullable: true city: description: Household city. type: string maxLength: 100 example: Kampala nullable: true state: description: Household state. type: string maxLength: 100 example: Central nullable: true postal_code: description: Household postal_code. type: string maxLength: 20 example: '00000' nullable: true country: description: Household country. type: string maxLength: 100 example: Uganda nullable: true type: object json_fields: description: Decoded household custom values. oneOf: - type: object additionalProperties: true - type: array items: type: string - type: string enum: - null nullable: true donor_ids: type: array items: description: Member donor ID. type: integer example: 42 donor_count: description: Current active donor count. type: integer example: 42 created_at: description: Created. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object emailsets: type: array items: $ref: '#/components/schemas/CrmApiHouseholdEmailSet' type: object '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Insufficient permission or feature access. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Household operation failed. content: application/json: schema: properties: success: description: Operation failed. type: boolean example: false message: description: Failure summary. type: string example: Failed to update household error: description: Underlying error message. type: string example: Unable to complete household change. type: object security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: CrmApiHouseholdEmailSet: properties: id: description: Email set ID. type: integer example: 42 client_id: description: Organization ID. type: integer example: 42 name: description: Email set label. type: string example: General donor emails from: description: Stored sender. type: string example: team@example.org emailtemplates: type: array items: properties: id: description: Template ID. type: integer example: 42 client_id: description: Organization ID. type: integer example: 42 emailset_id: description: Owning email set. type: integer example: 42 trigger: description: Stored template trigger. type: string example: Example nullable: true schedule: description: Stored template schedule. type: string example: Example nullable: true to: description: Stored template to. type: string example: Example nullable: true subject: description: Stored template subject. type: string example: Example nullable: true message: description: Stored template message. type: string example: Example nullable: true design: description: Stored template design. type: string example: Example nullable: true donation_type: description: Stored template donation_type. type: string example: Example nullable: true disabled: description: Stored disable flag. type: integer example: 0 created_at: description: Created. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object program: oneOf: - $ref: '#/components/schemas/Program' - type: string enum: - null nullable: true created_at: description: Created. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object Program: title: Program description: >- A program (a.k.a. campaign) groups entities, donor profile forms, settings, and email/SMS template sets. Programs form a hierarchy via the Cartalyst nested-set pattern (`lft`/`rgt`/`tree`). The two HysForm references differentiate the donor profile form (`donor_hysform_id`) from the entity / sponsorship profile form (`hysform_id`). required: - id - client_id - name properties: id: description: Internal program ID. type: integer format: int64 example: 11 client_id: description: Owning Gratona client. type: integer format: int64 example: 207 name: description: Human-readable program name. type: string example: Child Sponsorship 2026 type: description: >- Program type — `sponsorship`, `contribution`, `number of sponsors`, `campaign`, etc. Determines which UI flows are available. type: string example: Contribution nullable: true prefix: description: Receipt / commitment number prefix. type: string example: CS-2026 nullable: true link_id: description: >- Optional parent program ID; used for sub-program linking outside the nested-set tree. type: integer format: int64 example: null nullable: true hysform_id: description: >- HysForm defining the entity (recipient) profile fields for this program. type: integer format: int64 example: 42 donor_hysform_id: description: >- HysForm defining the donor profile fields for donors signing up under this program. type: integer format: int64 example: 43 setting_id: description: >- Settings record holding program-specific configuration (display options, public page copy, etc.). type: integer format: int64 example: 87 nullable: true emailset_id: description: Email template set used for automated emails on this program. type: integer format: int64 example: 14 nullable: true smsset_id: description: SMS template set used for automated SMS on this program. type: integer format: int64 example: null nullable: true lft: description: >- Nested-set left boundary (Cartalyst). Used for tree ordering — do not edit directly. type: integer example: 1 rgt: description: Nested-set right boundary (Cartalyst). type: integer example: 8 tree: description: Nested-set tree id. type: integer example: 1 created_at: type: string format: date-time example: '2025-01-01T00:00:00Z' updated_at: type: string format: date-time example: '2025-12-31T23:00:00Z' deleted_at: type: string format: date-time example: null nullable: true type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.