> ## 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. # Get a donation worksheet with query filters > GET variant of the donation worksheet, with the same organization/form scope and tab-specific projection as POST. Date defaults use organization time. Saved views fill omitted filters/columns and date presets. Search, filtering and sorting use the registered field contracts; totals and graphs can be skipped with includeSummary=false. Supplying report_name creates a saved report even through GET, so omit it for a read-only request. Prefer POST for large nested filter/column payloads. Requires permission: one of donations, reports_view, reports_manage. ## OpenAPI ````yaml get /admin/donations 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/donations: get: tags: - Donations summary: Get a donation worksheet with query filters description: >- GET variant of the donation worksheet, with the same organization/form scope and tab-specific projection as POST. Date defaults use organization time. Saved views fill omitted filters/columns and date presets. Search, filtering and sorting use the registered field contracts; totals and graphs can be skipped with includeSummary=false. Supplying report_name creates a saved report even through GET, so omit it for a read-only request. Prefer POST for large nested filter/column payloads. Requires permission: one of donations, reports_view, reports_manage. operationId: reference_Admin_DonationController_viewAllDonations parameters: - name: selectedTab in: query description: Worksheet mode; controls row and aggregate semantics. required: true schema: type: string enum: - Donations - Refunds - Failed - Soft Credits example: Donations - name: Donor_Group in: query description: >- Donor form within the current organization, or all forms. Required unless all=true; saved views do not fill this field. required: false schema: anyOf: - type: integer example: 42 - type: string enum: - all example: all example: all - name: all in: query description: Include every donor form; also enabled by Donor_Group=all. required: false schema: type: boolean example: false - name: date_from in: query description: >- Inclusive creation-date start; default30 days before today when both dates are omitted. Refund occurrence mode uses refund date instead. required: false schema: type: string format: date example: '2026-09-20' - name: date_to in: query description: >- Inclusive end date; default today. A single supplied date is used for both bounds. required: false schema: type: string format: date example: '2026-10-20' - name: pageSize in: query description: Requested page size; default10. required: false schema: type: integer example: 10 - name: pageIndex in: query description: One-based worksheet page; default1. required: false schema: type: integer example: 1 - name: includeSummary in: query description: >- Default true. False skips expensive summary/statistics/graph work and returns zero or empty aggregates. required: false schema: type: boolean example: true - name: include_summary in: query description: Compatibility alias for includeSummary. required: false schema: type: boolean example: true - name: query in: query description: Search across allowed donation/recognition fields. required: false schema: type: string example: Education - name: search_fields in: query description: Optional registered searchable field keys. required: false schema: type: array items: type: string example: donor_name example: - donor_name - name: filterGroups in: query description: >- Ordered field predicates. Unsupported stale view fields are sanitized; invalid literal values can return422. required: false schema: type: array items: required: - field - operator - value properties: field: type: string example: amount operator: type: string example: greater_than value: description: >- Filter operand matching the field and operator. Multi-select operators accept arrays. anyOf: - type: string example: Education - type: number example: 25 - type: boolean example: true - type: array items: type: string example: Education logicalOperator: description: >- Join to the following included condition; evaluated as a left fold. type: string enum: - AND - OR - null example: AND nullable: true type: object example: - field: amount operator: greater_than value: 25 logicalOperator: null - name: filterKey in: query description: Single-filter field when filterGroups is absent. required: false schema: type: string example: amount - name: filterOperator in: query description: Single-filter operator, default equals. required: false schema: type: string example: greater_than - name: filterValue in: query description: >- Filter operand matching the field and operator. Multi-select operators accept arrays. required: false schema: anyOf: - type: string example: Education - type: number example: 25 - type: boolean example: true - type: array items: type: string example: Education example: 25 - name: sortKey in: query description: >- Registered donation or recognition sort key; unsupported keys are ignored. required: false schema: type: string example: amount - name: sortOrder in: query description: Sort direction normalized by the sort-field contract. required: false schema: type: string enum: - asc - desc example: desc - name: sort_key in: query description: Compatibility alias for sortKey. required: false schema: type: string example: amount - name: sort_order in: query description: Compatibility alias for sortOrder. required: false schema: type: string example: desc - name: savedFilterId in: query description: >- Organization-owned Donations saved view whose preferences fill omitted values. required: false schema: type: integer example: 42 - name: saved_filter_id in: query description: Compatibility alias for savedFilterId. required: false schema: type: integer example: 42 - name: fields in: query description: >- Selected column keys as an array or JSON-encoded list. Controls related projections and response display flags. required: false schema: anyOf: - type: array items: type: string example: amount - type: string example: - donor_name - amount - date - name: in_kind in: query description: Restrict to in-kind gifts when true, or exclude them when false. required: false schema: type: boolean nullable: true example: false - name: in_kind_category in: query description: Optional in-kind category filter. required: false schema: type: string example: goods - name: sponsorship_type in: query description: Legacy one_time filter applied to displayed donation rows. required: false schema: anyOf: - type: integer example: 1 - type: string example: '1' example: 1 - name: refund_occurred in: query description: >- For the Refunds tab, select by applied refund occurrence dates with a legacy updated_at fallback. required: false schema: type: boolean example: false - name: dateRange in: query description: >- Relative date range materialized in organization time; all_time starts1970-01-01. required: false schema: anyOf: - properties: preset: description: Registered relative-date preset, or custom date range. type: string example: last_30_days from: type: string format: date example: '2026-01-01' nullable: true to: type: string format: date example: '2026-10-20' nullable: true type: object additionalProperties: true - description: JSON-encoded date-range object. type: string example: preset: last_30_days - name: date_range in: query description: Compatibility alias for dateRange. required: false schema: anyOf: - properties: preset: description: Registered relative-date preset, or custom date range. type: string example: last_30_days from: type: string format: date example: '2026-01-01' nullable: true to: type: string format: date example: '2026-10-20' nullable: true type: object additionalProperties: true - description: JSON-encoded date-range object. type: string example: preset: last_30_days - name: report_name in: query description: >- Optional nonblank name creates a saved Report as a side effect. Supply fields when saving. required: false schema: type: string example: October gifts responses: '200': description: Operation result. content: application/json: schema: $ref: '#/components/schemas/DonationWorksheetResult' '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: >- The selected tab, normalized date range or filter literal is invalid. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v1 description: Gratona API components: schemas: DonationWorksheetResult: description: >- The response also includes boolean display flags for selected built-in and standardized fields. properties: donations: type: array items: description: >- Gift/recognition worksheet projection varies with selectedTab and requested fields. Includes source, acknowledgement, custom profile and tax/recognition attributes as applicable. properties: donation_id: description: >- HTTP contracts traced from the deployed controller and delegated validation/serialization. type: integer example: 42 donor_id: type: integer example: 21 amount: type: string example: '25.00' actual_amount_charged: type: string example: '25.00' currency: type: string example: $ failed: type: boolean example: false transaction_status: type: string example: completed nullable: true profile: anyOf: - type: object additionalProperties: true - type: array items: type: string maxItems: 0 entity_profile: anyOf: - type: object additionalProperties: true - type: array items: type: string maxItems: 0 donor: type: object additionalProperties: true designation: type: object additionalProperties: true method: type: string example: Check method_id: anyOf: - type: integer example: 1 - type: string example: '1' refunded_amount: type: string example: '0.00' date: type: string format: date-time example: '2026-10-20T12:00:00Z' acknowledged: type: boolean example: false acknowledgement: type: string example: Unacknowledged giving_source: type: string example: direct soft_credits: type: array items: properties: id: type: integer example: 42 donor_id: type: integer example: 24 donor_name: type: string example: Jane Donor amount: type: string example: '25.00' type: type: string example: In Honor Of notes: type: string example: Community introduction nullable: true type: object type: object additionalProperties: true soft_credit_donations: type: array items: description: Recognition worksheet rows when selectedTab is Soft Credits. type: object additionalProperties: true organization: type: string example: Example Nonprofit client: $ref: '#/components/schemas/Client' number_of_allDonations: description: Filtered total row count for the current tab. type: integer example: 25 number_of_donations: description: Rows on this page. type: integer example: 10 total_of_donations: description: Tab-dependent aggregate, or zero when summary is disabled. anyOf: - type: string example: '625' - type: number example: 625 soft_credit_stats: anyOf: - type: object additionalProperties: true - type: array items: type: string maxItems: 0 soft_credit_graph_data: type: array items: type: object additionalProperties: true donation_graph_data: type: array items: type: object additionalProperties: true fields: type: array items: properties: field_key: type: string example: gift_example field_label: type: string example: Campaign source field_type: type: string example: hysText nullable: true field_group: type: string example: Donation Form Fields type: object date_from: type: string format: date example: '2026-09-20' date_to: type: string format: date example: '2026-10-20' program_totals: type: array items: type: object additionalProperties: true all: type: boolean example: true hysform: type: object additionalProperties: true current_year: type: integer example: 2026 last_year: type: integer example: 2025 show_standardized_fields: type: boolean example: true visible_standard_field_keys: type: array items: type: string example: first_name title_field_keys: type: array items: type: string example: first_name standard_title_field_keys: type: array items: type: string example: first_name sort: properties: key: type: string example: amount order: type: string example: desc type: object applied_filters: description: Applied saved-view preferences when a saved filter is selected. type: object additionalProperties: true type: object additionalProperties: true 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 Client: title: Client description: >- A Gratona client — the tenant of the multi-tenant system. Owns donors, entities, programs, users, and integrations. The `client_id` on every other resource scopes data to this row. Stripe Connect onboarding state, account-level settings, and the client's display name all live here. required: - id - organization properties: id: description: Internal client ID — referenced by every multi-tenant resource. type: integer format: int64 example: 207 organization: description: Display name of the organization. type: string example: Gratona Demo Org website: description: Organization website. type: string example: https://demo.gratona.com nullable: true email: description: Primary contact email for the organization. type: string format: email example: hello@demo.gratona.com nullable: true stripe_connect_id: description: >- Stripe Connect account id once onboarding completes; null until the org has finished Stripe onboarding. type: string example: acct_1OqXXXXX nullable: true previous_stripe_connect_id: description: >- Prior Stripe Connect account id, kept around when the client migrates between Connect accounts. type: string example: null nullable: true completed_stripe_onboarding: description: >- Whether the org has finished the Stripe Connect onboarding flow and can accept Stripe payments. type: boolean example: true date_format: description: >- Stored organization date-format setting token. API and admin surfaces resolve this token to the corresponding display pattern. type: string enum: - m-d-Y - d-m-Y - Y-m-d example: Y-m-d timezone: description: 'Computed accessor: client timezone derived from settings.' type: string example: America/Chicago nullable: true custom: description: >- Legacy free-form JSON column for arbitrary client-level configuration. type: object nullable: true additionalProperties: true frequency: description: Legacy frequency configuration for billing / payment plans (JSON). type: object nullable: true additionalProperties: true custom_start_date: description: Legacy billing custom start date marker. type: string example: null nullable: true custom_amount: description: Legacy billing custom amount marker. type: number format: float example: null nullable: true created_at: type: string format: date-time example: '2024-06-01T12:00:00Z' updated_at: type: string format: date-time example: '2026-01-01T00:00:00Z' 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.