> ## 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. # Read fundraising overview metrics > Computes current/comparison financial-ledger and contact metrics, stewardship alerts and cohort summaries. Uses a short user/filter/settings cache; refresh bypasses it. Relationship donor visibility and plan feature permissions apply. Requires permission: one of donors_view. ## OpenAPI ````yaml get /admin/fundraising/overview 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/fundraising/overview: get: tags: - Fundraising summary: Read fundraising overview metrics description: >- Computes current/comparison financial-ledger and contact metrics, stewardship alerts and cohort summaries. Uses a short user/filter/settings cache; refresh bypasses it. Relationship donor visibility and plan feature permissions apply. Requires permission: one of donors_view. operationId: fundraisingHubOverview parameters: - name: acknowledgement_work_scope in: query description: >- Acknowledgement work scope. Validation: nullable; allowed values: active, historical, all. required: false schema: type: string enum: - active - historical - all - null nullable: true example: active - name: fundraiser_user_id in: query description: >- Relationship-manager id, all or unassigned; scoped by donor visibility. required: false schema: type: string maxLength: 64 nullable: true example: all - name: group_by_household in: query description: >- Boolean-like query input; true/false and numeric forms are normalized by this workflow. required: false schema: type: boolean nullable: true example: false - name: search in: query description: 'Search. Validation: nullable, string, max:255.' required: false schema: type: string maxLength: 255 nullable: true example: education - name: date_from in: query description: 'Date from. Validation: nullable, date.' required: false schema: type: string format: date-time nullable: true example: '2026-10-20T12:00:00Z' - name: date_to in: query description: 'Date to. Validation: nullable, date.' required: false schema: type: string format: date-time nullable: true example: '2026-10-20T12:00:00Z' - name: state in: query description: 'State. Validation: nullable, string, max:64.' required: false schema: type: string maxLength: 64 nullable: true example: State - name: comparison_mode in: query description: 'Comparison mode. Validation: nullable, string, max:64.' required: false schema: type: string maxLength: 64 nullable: true example: Comparison Mode - name: current_start in: query description: 'Current start. Validation: nullable, date.' required: false schema: type: string format: date-time nullable: true example: '2026-10-20T12:00:00Z' - name: current_end in: query description: 'Current end. Validation: nullable, date.' required: false schema: type: string format: date-time nullable: true example: '2026-10-20T12:00:00Z' - name: comparison_start in: query description: 'Comparison start. Validation: nullable, date.' required: false schema: type: string format: date-time nullable: true example: '2026-10-20T12:00:00Z' - name: comparison_end in: query description: 'Comparison end. Validation: nullable, date.' required: false schema: type: string format: date-time nullable: true example: '2026-10-20T12:00:00Z' - name: refresh in: query description: >- Boolean-like query input; true/false and numeric forms are normalized by this workflow. required: false schema: type: boolean nullable: true example: false - name: page in: query description: 'Page. Validation: nullable, integer, min:1.' required: false schema: type: integer minimum: 1 nullable: true example: 1 - name: per_page in: query description: 'Per page. Validation: nullable, integer, min:10, max:100.' required: false schema: type: integer maximum: 100 minimum: 10 nullable: true example: 10 responses: '200': description: Operation result. content: application/json: schema: properties: status: type: string example: success data: $ref: '#/components/schemas/FundraisingHubOverview' type: object '401': description: Authentication is required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The authenticated user lacks access to this workflow or its related records. '422': description: >- Request, policy, source relationship, lifecycle or selection validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: FundraisingHubOverview: description: >- Revenue is the qualified financial ledger; active donor counts exclude giving institutions. Interaction metrics use canonical contact qualification; Work is permission/feature scoped. properties: periods: $ref: '#/components/schemas/FundraisingHubPeriods' settings: $ref: '#/components/schemas/FundraisingHubSettings' metrics: properties: total_revenue: description: Amount or percentage. type: number example: 25 nullable: true total_revenue_delta: description: Amount or percentage. type: number example: 25 nullable: true active_donors_delta: description: Amount or percentage. type: number example: 25 nullable: true total_interactions_delta: description: Amount or percentage. type: number example: 25 nullable: true engagement_rate: description: Amount or percentage. type: number example: 25 nullable: true unacknowledged_gift_amount: description: Amount or percentage. type: number example: 25 nullable: true active_donors: description: Count. type: integer example: 2 nullable: false total_interactions: description: Count. type: integer example: 2 nullable: false contact_count: description: Count. type: integer example: 2 nullable: false meaningful_connections: description: Count. type: integer example: 2 nullable: false meaningful_contact_count: description: Count. type: integer example: 2 nullable: false open_work_items: description: Count. type: integer example: 2 nullable: false unacknowledged_gifts: description: Count. type: integer example: 2 nullable: false type: object metric_basis: type: object additionalProperties: type: string comparison: properties: revenue: type: array items: properties: label: description: Serialized value. type: string example: Example nullable: true value: description: Amount or percentage. type: number example: 25 nullable: false type: object donors: type: array items: properties: label: description: Serialized value. type: string example: Example nullable: true value: description: Amount or percentage. type: number example: 25 nullable: false type: object interactions: type: array items: properties: label: description: Serialized value. type: string example: Example nullable: true value: description: Amount or percentage. type: number example: 25 nullable: false type: object type: object metric_explanations: properties: revenue: properties: current_revenue: description: Amount or percentage. type: number example: 25 nullable: false comparison_revenue: description: Amount or percentage. type: number example: 25 nullable: false revenue_change: description: Amount or percentage. type: number example: 25 nullable: false new_revenue: description: Amount or percentage. type: number example: 25 nullable: false lost_revenue: description: Amount or percentage. type: number example: 25 nullable: false upgrade_change: description: Amount or percentage. type: number example: 25 nullable: false downgrade_change: description: Amount or percentage. type: number example: 25 nullable: false maintained_change: description: Amount or percentage. type: number example: 25 nullable: false reconciled_revenue_change: description: Amount or percentage. type: number example: 25 nullable: false current_donors: description: Count. type: integer example: 2 nullable: false comparison_donors: description: Count. type: integer example: 2 nullable: false donor_change: description: Count. type: integer example: 2 nullable: false new_donors: description: Count. type: integer example: 2 nullable: false lost_donors: description: Count. type: integer example: 2 nullable: false current_label: description: Serialized value. type: string example: Example nullable: true comparison_label: description: Serialized value. type: string example: Example nullable: true type: object active_donors: properties: current_revenue: description: Amount or percentage. type: number example: 25 nullable: false comparison_revenue: description: Amount or percentage. type: number example: 25 nullable: false revenue_change: description: Amount or percentage. type: number example: 25 nullable: false new_revenue: description: Amount or percentage. type: number example: 25 nullable: false lost_revenue: description: Amount or percentage. type: number example: 25 nullable: false upgrade_change: description: Amount or percentage. type: number example: 25 nullable: false downgrade_change: description: Amount or percentage. type: number example: 25 nullable: false maintained_change: description: Amount or percentage. type: number example: 25 nullable: false reconciled_revenue_change: description: Amount or percentage. type: number example: 25 nullable: false current_donors: description: Count. type: integer example: 2 nullable: false comparison_donors: description: Count. type: integer example: 2 nullable: false donor_change: description: Count. type: integer example: 2 nullable: false new_donors: description: Count. type: integer example: 2 nullable: false lost_donors: description: Count. type: integer example: 2 nullable: false current_label: description: Serialized value. type: string example: Example nullable: true comparison_label: description: Serialized value. type: string example: Example nullable: true type: object type: object stewardship: properties: unacknowledged_gifts: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false oldest_date: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true oldest_age_days: description: Count. type: integer example: 2 nullable: true type: object work_items: properties: total: description: Count. type: integer example: 2 nullable: false by_type: type: object additionalProperties: description: Count. type: integer example: 2 nullable: false type: object type: object alerts: type: array items: properties: key: description: Serialized value. type: string example: Example nullable: true label: description: Serialized value. type: string example: Example nullable: true value: description: Count. type: integer example: 2 nullable: false detail: description: Serialized value. type: string example: Example nullable: true path: description: Serialized value. type: string example: Example nullable: true type: object cohorts: properties: current_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object new_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object lost_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object upgraded_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object downgraded_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object maintained_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object retained_donors: properties: count: description: Count. type: integer example: 2 nullable: false amount: description: Amount or percentage. type: number example: 25 nullable: false donor_ids: type: array items: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false type: object type: object projection_freshness: $ref: '#/components/schemas/FundraisingHubFreshness' type: object UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object RequestRejection: description: >- Request or workflow rejection. Framework field-validation failures contain errors; semantic rejections may contain message without errors; legacy/provider failures may use error and error_code. The operation description identifies the rejected condition. Domain responses may add current revision, limits or other conflict context. anyOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/ErrorResponse' - required: - error properties: error: description: Legacy or provider-facing error message. type: string example: The request could not be completed. error_code: description: Stable domain error code, when provided. type: string example: WORKFLOW_UNAVAILABLE type: object FundraisingHubPeriods: properties: mode: type: string example: ytd_vs_last_year_ytd current_start: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true current_end: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true comparison_start: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true comparison_end: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true current: properties: start: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true end: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true label: description: Serialized value. type: string example: Example nullable: false type: object comparison: properties: start: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true end: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true label: description: Serialized value. type: string example: Example nullable: false type: object type: object FundraisingHubSettings: description: >- Canonical organization fundraising settings, normalized defaults and only this viewer's comparison preference. properties: comparison: description: 'Comparison. Validation: nullable, array.' properties: default_mode: description: 'Comparison / default mode. Validation: nullable, string, max:64.' type: string maxLength: 64 example: Comparison.Default Mode nullable: true effective_default_mode: description: Effective personal default, or organization default. type: string example: Example nullable: false type: object nullable: true user_preferences: description: 'User preferences. Validation: nullable, array.' properties: comparison: description: 'User preferences / comparison. Validation: nullable, array.' properties: default_mode: description: >- User preferences / comparison / default mode. Validation: nullable, string, max:64. type: string maxLength: 64 example: User Preferences.Comparison.Default Mode nullable: true type: object nullable: true type: object nullable: true caseload: description: 'Caseload. Validation: nullable, array.' properties: major_gift_threshold: description: >- Caseload / major gift threshold. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true mid_level_threshold: description: >- Caseload / mid level threshold. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true at_risk_months: description: 'Caseload / at risk months. Validation: nullable, integer, min:1.' type: integer minimum: 1 example: 1 nullable: true lapsed_months: description: 'Caseload / lapsed months. Validation: nullable, integer, min:1.' type: integer minimum: 1 example: 1 nullable: true needs_contact_days: description: >- Caseload / needs contact days. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true new_donor_window_days: description: >- Caseload / new donor window days. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true upgrade_potential_threshold_pct: description: >- Caseload / upgrade potential threshold pct. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true giving_trend_threshold_pct: description: >- Caseload / giving trend threshold pct. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true minimum_gifts_for_trend: description: >- Caseload / minimum gifts for trend. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true type: object nullable: true portfolio: description: 'Portfolio. Validation: nullable, array.' properties: major_gift_threshold: description: >- Portfolio / major gift threshold. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true mid_level_threshold: description: >- Portfolio / mid level threshold. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true at_risk_months: description: >- Portfolio / at risk months. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true lapsed_months: description: 'Portfolio / lapsed months. Validation: nullable, integer, min:1.' type: integer minimum: 1 example: 1 nullable: true needs_contact_days: description: >- Portfolio / needs contact days. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true new_donor_window_days: description: >- Portfolio / new donor window days. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true upgrade_potential_threshold_pct: description: >- Portfolio / upgrade potential threshold pct. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true giving_trend_threshold_pct: description: >- Portfolio / giving trend threshold pct. Validation: nullable, numeric, min:0. type: number minimum: 0 example: 25 nullable: true minimum_gifts_for_trend: description: >- Portfolio / minimum gifts for trend. Validation: nullable, integer, min:1. type: integer minimum: 1 example: 1 nullable: true type: object nullable: true cohorts: description: 'Cohorts. Validation: nullable, array.' properties: upgrade_threshold_pct: description: 'Cohorts / upgrade threshold pct. Validation: nullable, numeric.' type: number example: 25 nullable: true downgrade_threshold_pct: description: >- Cohorts / downgrade threshold pct. Validation: nullable, numeric. type: number example: 25 nullable: true maintained_tolerance_pct: description: >- Cohorts / maintained tolerance pct. Validation: nullable, numeric. type: number example: 25 nullable: true type: object nullable: true acknowledgements: description: 'Acknowledgements. Validation: nullable, array.' properties: enabled: description: 'Acknowledgements / enabled. Validation: nullable, boolean.' type: boolean example: true nullable: true stewardship_start_date: description: >- Acknowledgements / stewardship start date. Validation: nullable, date_format:Y-m-d. type: string format: date example: '2026-10-20' nullable: true initial_backfill_days: description: >- Acknowledgements / initial backfill days. Validation: nullable, integer; allowed values: 0, 30, 60, 90. type: integer enum: - 0 - 30 - 60 - 90 - null example: 0 nullable: true pending_after_days: description: >- Acknowledgements / pending after days. Validation: nullable, integer, min:0. type: integer minimum: 0 example: 1 nullable: true auto_email_can_acknowledge_default: description: >- Acknowledgements / auto email can acknowledge default. Validation: nullable, boolean. type: boolean example: true nullable: true allowed_sources: description: 'Acknowledgements / allowed sources. Validation: nullable, array.' type: array items: {} nullable: true stewardship_configured: description: Workflow state. type: boolean example: true source: type: string example: donations_acknowledged_at type: object nullable: true filters: description: 'Filters. Validation: nullable, array.' properties: default_group_by_household: description: >- Filters / default group by household. Validation: nullable, boolean. type: boolean example: true nullable: true type: object nullable: true planning: description: 'Planning. Validation: nullable, array.' properties: strategy_review_days: description: >- Planning / strategy review days. Validation: nullable, integer, min:1, max:730. type: integer maximum: 730 minimum: 1 example: 1 nullable: true qualification_stall_days: description: >- Planning / qualification stall days. Validation: nullable, integer, min:1, max:365. type: integer maximum: 365 minimum: 1 example: 1 nullable: true severely_overdue_days: description: >- Planning / severely overdue days. Validation: nullable, integer, min:1, max:365. type: integer maximum: 365 minimum: 1 example: 1 nullable: true annual_review_reminder_days: description: >- Planning / annual review reminder days. Validation: nullable, integer, min:1, max:365. type: integer maximum: 365 minimum: 1 example: 1 nullable: true qualification_template_version: description: >- Planning / qualification template version. Validation: nullable, integer, in:1; allowed values: 1. type: integer enum: - 1 - null example: 1 nullable: true default_period: description: >- Planning / default period. Validation: nullable, string; allowed values: calendar_year. type: string enum: - calendar_year - null example: calendar_year nullable: true type: object nullable: true relationship_provisioning: description: 'Relationship provisioning. Validation: nullable, array.' properties: policy_version: description: >- Relationship provisioning / policy version. Validation: nullable, integer, in:1; allowed values: 1. type: integer enum: - 1 - null example: 1 nullable: true enabled: description: >- Relationship provisioning / enabled. Validation: nullable, boolean. type: boolean example: true nullable: true default_giving_scope: description: >- Relationship provisioning / default giving scope. Validation: nullable; allowed values: attributed_only, all_qualified. type: string enum: - attributed_only - all_qualified - null example: attributed_only nullable: true relationship_type_mappings: description: >- Relationship provisioning / relationship type mappings. Validation: nullable, array, max:25. type: array items: required: - key - core_relationship_type - vehicle_relationship_type - kind - decision properties: key: description: >- Relationship provisioning / relationship type mappings item / key. Validation: required, string, max:64, regex:/^[a-z0-9][a-z0-9_]*$/. type: string maxLength: 64 pattern: ^[a-z0-9][a-z0-9_]*$ example: donor_advised_fund core_relationship_type: description: >- Relationship provisioning / relationship type mappings item / core relationship type. Validation: required, string, max:127. type: string maxLength: 127 example: >- Relationship Provisioning.Relationship Type Mappings.*.Core Relationship Type vehicle_relationship_type: description: >- Relationship provisioning / relationship type mappings item / vehicle relationship type. Validation: required, string, max:127. type: string maxLength: 127 example: >- Relationship Provisioning.Relationship Type Mappings.*.Vehicle Relationship Type kind: description: >- Relationship provisioning / relationship type mappings item / kind. Validation: required; allowed values: family_fund, business_family, organization. type: string enum: - family_fund - business_family - organization example: family_fund decision: description: >- Relationship provisioning / relationship type mappings item / decision. Validation: required; allowed values: auto_create, review, ignore. type: string enum: - auto_create - review - ignore example: auto_create type: object maxItems: 25 nullable: true type: object nullable: true attribution: description: 'Attribution. Validation: nullable, array.' properties: policy_version: description: >- Attribution / policy version. Validation: nullable, integer, in:1; allowed values: 1. type: integer enum: - 1 - null example: 1 nullable: true soft_credit_types: description: Soft-credit type-key policies. type: object additionalProperties: properties: relationship_giving: description: Workflow state. type: boolean example: true relationship_reactivation: description: Workflow state. type: boolean example: true giving_anniversary: description: Workflow state. type: boolean example: true relationship_follow_up: description: Workflow state. type: boolean example: true type: object relationship_follow_up: description: >- Attribution / relationship follow up. Validation: nullable, array. properties: enabled: description: >- Attribution / relationship follow up / enabled. Validation: nullable, boolean. type: boolean example: true nullable: true due_days_after: description: >- Attribution / relationship follow up / due days after. Validation: nullable, integer, min:0, max:365. type: integer maximum: 365 minimum: 0 example: 1 nullable: true lookback_days: description: >- Attribution / relationship follow up / lookback days. Validation: nullable, integer, min:1, max:3650. type: integer maximum: 3650 minimum: 1 example: 1 nullable: true type: object nullable: true soft_credit_type_options: description: >- Present in settings/editor responses; omitted from calculation-only snapshots. type: array items: properties: key: description: Serialized value. type: string example: Example nullable: false name: description: Serialized value. type: string example: Example nullable: false type: object type: object nullable: true reactivation: description: 'Reactivation. Validation: nullable, array.' properties: allowed_actions: description: 'Reactivation / allowed actions. Validation: nullable, array.' type: array items: {} nullable: true type: object nullable: true interactions: description: 'Interactions. Validation: nullable, array.' properties: classification_version: description: >- Interactions / classification version. Validation: nullable, integer, in:2; allowed values: 2. type: integer enum: - 2 - null example: 2 nullable: true meaningful_channels: description: 'Interactions / meaningful channels. Validation: nullable, array.' type: array items: description: >- Interactions / meaningful channels item. Validation: string, max:64. type: string maxLength: 64 example: Interactions.Meaningful Channels.* nullable: true meaningful_purposes: description: 'Interactions / meaningful purposes. Validation: nullable, array.' type: array items: description: >- Interactions / meaningful purposes item. Validation: string, max:64. type: string maxLength: 64 example: Interactions.Meaningful Purposes.* nullable: true meaningful_outcomes: description: 'Interactions / meaningful outcomes. Validation: nullable, array.' type: array items: description: >- Interactions / meaningful outcomes item. Validation: string; allowed values: completed, resolved. type: string enum: - completed - resolved example: completed nullable: true meaningful_directions: description: >- Interactions / meaningful directions. Validation: nullable, array. type: array items: description: >- Interactions / meaningful directions item. Validation: string; allowed values: inbound, outbound, internal, none. type: string enum: - inbound - outbound - internal - none example: inbound nullable: true meaningful_provider_purposes: description: >- Interactions / meaningful provider purposes. Validation: nullable, array. type: array items: description: >- Interactions / meaningful provider purposes item. Validation: string, max:64. type: string maxLength: 64 example: Interactions.Meaningful Provider Purposes.* nullable: true meaningful_keywords: description: 'Interactions / meaningful keywords. Validation: nullable, array.' type: array items: description: >- Interactions / meaningful keywords item. Validation: string, max:64. type: string maxLength: 64 example: Interactions.Meaningful Keywords.* nullable: true meaningful_subject_markers: description: >- Interactions / meaningful subject markers. Validation: nullable, array. type: array items: description: >- Interactions / meaningful subject markers item. Validation: string, max:64, regex:/^[\pL\pN][\pL\pN _.-]*$/u. type: string maxLength: 64 pattern: ^[\pL\pN][\pL\pN _.-]*$ example: meaningful nullable: true excluded_contact_purposes: description: >- Interactions / excluded contact purposes. Validation: nullable, array. type: array items: description: >- Interactions / excluded contact purposes item. Validation: string, max:64. type: string maxLength: 64 example: Interactions.Excluded Contact Purposes.* nullable: true type: object nullable: true suggestions: description: 'Suggestions. Validation: nullable, array.' properties: enabled: description: 'Suggestions / enabled. Validation: nullable, boolean.' type: boolean example: true nullable: true playbook: description: >- Suggestions / playbook. Validation: nullable; allowed values: balanced, high_touch_majors, digital_first, card_forward, custom. type: string enum: - balanced - high_touch_majors - digital_first - card_forward - custom - null example: balanced nullable: true moments: description: 'Suggestions / moments. Validation: nullable, array.' properties: first_gift: description: >- Suggestions / moments / first gift. Validation: nullable; allowed values: call, text, email, handwritten_card, log. type: string enum: - call - text - email - handwritten_card - log - null example: call nullable: true major_gift: description: >- Suggestions / moments / major gift. Validation: nullable; allowed values: call, text, email, handwritten_card, log. type: string enum: - call - text - email - handwritten_card - log - null example: call nullable: true giving_anniversary: description: >- Suggestions / moments / giving anniversary. Validation: nullable; allowed values: call, text, email, handwritten_card, log. type: string enum: - call - text - email - handwritten_card - log - null example: call nullable: true reactivation: description: >- Suggestions / moments / reactivation. Validation: nullable; allowed values: call, text, email, handwritten_card, log. type: string enum: - call - text - email - handwritten_card - log - null example: call nullable: true sustainer_milestone: description: >- Suggestions / moments / sustainer milestone. Validation: nullable; allowed values: call, text, email, handwritten_card, log. type: string enum: - call - text - email - handwritten_card - log - null example: call nullable: true type: object nullable: true scope: description: 'Suggestions / scope. Validation: nullable, array.' properties: dashboard: description: >- Suggestions / scope / dashboard. Validation: nullable, boolean. type: boolean example: true nullable: true donor_record: description: >- Suggestions / scope / donor record. Validation: nullable, boolean. type: boolean example: true nullable: true work_queue: description: >- Suggestions / scope / work queue. Validation: nullable, boolean. type: boolean example: true nullable: true after_gift_entry: description: >- Suggestions / scope / after gift entry. Validation: nullable, boolean. type: boolean example: true nullable: true type: object nullable: true guardrails: description: 'Suggestions / guardrails. Validation: nullable, array.' properties: touch_fatigue_cap_per_30_days: description: >- Suggestions / guardrails / touch fatigue cap per 30 days. Validation: nullable, integer, min:0, max:30. type: integer maximum: 30 minimum: 0 example: 1 nullable: true respect_channel_consent: description: >- Suggestions / guardrails / respect channel consent. Validation: nullable, boolean. type: boolean example: true nullable: true budget_aware_downgrade: description: >- Suggestions / guardrails / budget aware downgrade. Validation: nullable, boolean. type: boolean example: true nullable: true channel_cooldown_days: description: >- Suggestions / guardrails / channel cooldown days. Validation: nullable, integer, min:0, max:365. type: integer maximum: 365 minimum: 0 example: 1 nullable: true type: object nullable: true type: object nullable: true digest: description: 'Digest. Validation: nullable, array.' properties: enabled: description: 'Digest / enabled. Validation: nullable, boolean.' type: boolean example: true nullable: true frequency: description: >- Digest / frequency. Validation: nullable; allowed values: daily, weekly, monthly. type: string enum: - daily - weekly - monthly - null example: daily nullable: true weekday: description: >- Digest / weekday. Validation: nullable; allowed values: monday, tuesday, wednesday, thursday, friday, saturday, sunday. type: string enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - null example: monday nullable: true recipients: description: 'Digest / recipients. Validation: nullable, array.' type: array items: description: 'Digest / recipients item. Validation: email.' type: string format: email example: jane@example.org nullable: true include_anniversaries: description: 'Digest / include anniversaries. Validation: nullable, boolean.' type: boolean example: true nullable: true include_unacknowledged_gifts: description: >- Digest / include unacknowledged gifts. Validation: nullable, boolean. type: boolean example: true nullable: true include_reactivation: description: 'Digest / include reactivation. Validation: nullable, boolean.' type: boolean example: true nullable: true type: object nullable: true stewardship_setup: properties: required: description: Workflow state. type: boolean example: true today: description: Organization-local calendar date. type: string format: date example: '2026-10-20' nullable: true timezone: description: Serialized value. type: string example: Example nullable: false type: object type: object FundraisingHubFreshness: properties: status: type: string enum: - unknown - stale - fresh example: fresh is_stale: description: Workflow state. type: boolean example: true last_success_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true stale_after_minutes: description: Count. type: integer example: 2 nullable: false type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. 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 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.