> ## 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. # Filter donor worksheet rows > Searches active or archived organization donors in one form or all forms. Resolves saved views, allowed filters and selected columns, retaining canonical identity/photo fields. Returns a paged configurable projection and full matching count. Uses current search/SQL fallbacks; an advanced date field can override the top-level creation-date range. Dates in row projections follow organization display formatting. Requires permission: one of donors_manage. ## OpenAPI ````yaml post /admin/all_donors/filter/{hysform_id} 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/all_donors/filter/{hysform_id}: post: tags: - Donors summary: Filter donor worksheet rows description: >- Searches active or archived organization donors in one form or all forms. Resolves saved views, allowed filters and selected columns, retaining canonical identity/photo fields. Returns a paged configurable projection and full matching count. Uses current search/SQL fallbacks; an advanced date field can override the top-level creation-date range. Dates in row projections follow organization display formatting. Requires permission: one of donors_manage. operationId: adminDonorShowAllDonorsAjax parameters: - name: hysform_id in: path description: Donor form id or all forms. required: true schema: oneOf: - type: integer example: 42 - type: string enum: - all example: all example: all requestBody: description: Validated request fields for this operation. required: false content: application/json: schema: $ref: '#/components/schemas/AdminDonorWorksheetRequest' responses: '200': description: Operation result. content: application/json: schema: description: >- length is total matching rows, not this page length. Row shape follows the current form and selected columns. required: - data - length - filter - applied_filters properties: data: type: array items: $ref: '#/components/schemas/AdminDonorWorksheetRow' length: type: integer minimum: 0 example: 42 filter: description: >- Echoed active/archive selector; string, boolean or null depending on request/defaults. applied_filters: $ref: '#/components/schemas/AdminWorksheetAppliedFilters' all: type: boolean example: true date_from: type: string example: '2026-01-01' date_to: type: string example: '2026-10-20' type: object '400': description: Form id is the null sentinel. '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: >- Advanced filter/relationship/date input is invalid or a required bounded search fallback is unavailable. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: AdminDonorWorksheetRequest: description: >- Donor form worksheet state. The path supplies form scope; filters/search/date/sort are resolved with saved view settings. filter is conditionally required with filterGroups. Pagination defaults to page1, size10; hysform_id=all combines forms. properties: filter: description: >- Archived-view selector. Use string false for active and true for archived. Recipient views also support available, sponsored and unsponsored. type: string example: 'false' filterGroups: description: >- Multiple typed comparisons. Requires filter when present; value is required except supported presence/empty operators. Saved-view filters are sanitized to current allowed fields. type: array items: $ref: '#/components/schemas/AdminWorksheetFilterGroup' query: description: >- Worksheet search text; recipient search defaults to title/id fields when keysArray is absent. type: string example: Jane keysArray: description: Legacy comparison/search field keys. type: array items: type: string example: display_name comparisonOperator: description: Legacy single comparison operator. type: string example: contains savedFilterId: description: >- Saved view/report from this organization and worksheet module; missing/unmatched ids are ignored. type: integer example: 42 saved_filter_id: description: Compatibility alias for savedFilterId. type: integer example: 42 fields: description: Selected column keys; defaults to saved/current form preferences. type: array items: type: string example: display_name column_order: description: Preferred allowed column ordering. type: array items: type: string example: display_name sortKey: description: Allowed selected/system/custom sort key. type: string example: display_name sortOrder: description: >- Sort direction; unsupported directions normalize to asc where validated. type: string enum: - asc - desc example: asc pageIndex: description: >- One-based worksheet page. Supply with pageSize for predictable bounded pagination. type: integer example: 1 pageSize: description: >- Requested worksheet page length; donor lists default to10 and clamp to at least1. type: integer example: 25 date_from: description: >- Lower date bound, interpreted with module/saved report date semantics. type: string format: date example: '2026-01-01' date_to: description: >- Upper date bound; donor created-at range applies when both bounds are supplied and no advanced date override exists. type: string format: date example: '2026-10-20' type: object AdminDonorWorksheetRow: description: >- Configurable worksheet projection, not a full donor resource. Identity/photo fields are hydrated independently of selected columns. Standardized profile fields, tenant form field keys, engagement dates, commitment metrics and selected contribution totals may be added; values keep their current display formatting and can be strings, numbers, arrays or objects. properties: id: oneOf: - type: integer example: 42 - type: string example: '42' hysform_id: oneOf: - type: integer example: 42 - type: string example: '42' display_name: type: string example: Jane Donor display_name_source: type: string example: profile_resolver profile_photo_thumb_url: description: >- Signed thumbnail URL, or empty string without a usable profile image. type: string example: https://example.org/thumb.jpg profile_photo_updated_at: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true email: type: string example: jane@example.org username: type: string example: jane@example.org tags: description: Selected tag column in its stored/presented form. created_at: type: string example: Oct 20, 2026 updated_at: type: string example: Oct 20, 2026 last_gift_date: type: string example: Oct 20, 2026 type: object additionalProperties: {} AdminWorksheetAppliedFilters: description: >- Resolved saved/manual filter or column-order metadata; null when no applicable configuration exists. Additional fields include saved date range, selected tab and form-specific context. Recipient views can include general column preferences even without a saved filter. properties: saved_filter_id: oneOf: - type: integer example: 42 nullable: true - type: string example: '42' saved_filter_name: type: string example: Active monthly supporters filter_groups: type: array items: $ref: '#/components/schemas/AdminWorksheetFilterGroup' fields: description: Effective selected columns or saved filter field payload. type: array items: {} column_order: type: array items: type: string example: display_name page_index: oneOf: - type: integer example: 42 - type: string example: '42' page_size: oneOf: - type: integer example: 42 - type: string example: '42' date_from: type: string example: '2026-01-01' nullable: true date_to: type: string example: '2026-10-20' nullable: true query: type: string example: Jane sort_key: type: string example: display_name sort_order: type: string example: asc sort: properties: key: type: string example: display_name order: type: string example: asc type: object footer_calculations: type: array items: type: object additionalProperties: {} type: object nullable: true additionalProperties: {} 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 AdminWorksheetFilterGroup: required: - field - operator properties: field: description: >- System or tenant form field key allowed in the current module/program. type: string example: display_name operator: description: >- Field-compatible comparison, for example equals, notEquals, contains, startsWith, isUnknown, hasAnyValue, isEmpty, greater_than or less_than. Date/age/relationship fields use their field-specific supported operators. type: string example: contains value: description: >- Comparison value. Required except presence/empty operators; scalar, list or field-specific structured date/relationship value. logicalOperator: description: >- Join this valid group to the following group; defaults to AND. Additional field metadata may be passed for typed date and custom-field comparisons. type: string enum: - AND - OR example: AND type: object additionalProperties: {} 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.