> ## 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 grouped duplicate-donor results > Returns paginated groups of likely-duplicate donors. Each group is an array of `Donor` objects (primary donor first, then linked duplicates) reconstructed from the `DuplicateDonor` link table; groups where the user has marked donors as not-duplicate are filtered out automatically. Supports both `page` and `pageIndex` query keys for backwards compatibility. Free-text `search` matches the primary donor or any of its linked duplicates across username, email, and form `is_title` fields. `fieldFilters` and `filterRules` further narrow the result set on standardized columns, custom JSON fields, or year-to-date contribution buckets. Requires permission: `duplicates_manage` (also satisfied by `donors_manage`). ## OpenAPI ````yaml get /admin/donors/duplicates/results 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 sponsorship relationships, lifecycle transitions, and sponsorship-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: Client description: Client - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Files description: Files - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User paths: /admin/donors/duplicates/results: get: tags: - Donors summary: List grouped duplicate-donor results description: >- Returns paginated groups of likely-duplicate donors. Each group is an array of `Donor` objects (primary donor first, then linked duplicates) reconstructed from the `DuplicateDonor` link table; groups where the user has marked donors as not-duplicate are filtered out automatically. Supports both `page` and `pageIndex` query keys for backwards compatibility. Free-text `search` matches the primary donor or any of its linked duplicates across username, email, and form `is_title` fields. `fieldFilters` and `filterRules` further narrow the result set on standardized columns, custom JSON fields, or year-to-date contribution buckets. Requires permission: `duplicates_manage` (also satisfied by `donors_manage`). operationId: d08a20f845e8af2dd93a97ab9e346470 parameters: - name: page in: query description: >- 1-indexed page number. Validation: `sometimes|integer|min:1`. Falls back to `pageIndex` then `1`. required: false schema: type: integer minimum: 1 example: 1 - name: pageIndex in: query description: 'Alias for `page`. Validation: `sometimes|integer|min:1`.' required: false schema: type: integer minimum: 1 example: 1 - name: pageSize in: query description: >- Group rows per page. Validation: `sometimes|integer|min:1|max:100`. Defaults to 10. required: false schema: type: integer maximum: 100 minimum: 1 example: 10 - name: search in: query description: >- Free-text search. Validation: `sometimes|string|max:100|nullable`. Wildcards `%` and `_` are stripped server-side. required: false schema: type: string maxLength: 100 nullable: true example: Smith - name: hysform_id in: query description: >- Restrict to one donor form. Validation: `sometimes|nullable|integer`. required: false schema: type: integer nullable: true example: 42 - name: fieldFilters in: query description: >- Map of `json_fields` key to substring filter. Applied after grouping. Validation: `sometimes|array`. required: false schema: type: object additionalProperties: true - name: filterRules in: query description: >- Array of `{fieldKey, operator, value}` rules. `operator` ∈ `equals`, `greater_than`, `less_than`, `is_empty`. Validation: `sometimes|array`. required: false schema: type: array items: type: object responses: '200': description: Paginated duplicate groups. content: application/json: schema: properties: duplicates: description: >- Page of duplicate groups (each group is an array of donors). type: array items: type: array items: $ref: '#/components/schemas/Donor' total: type: integer example: 37 pageIndex: type: integer example: 1 pageSize: type: integer example: 10 type: object '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: Donor: title: Donor description: >- A donor record. Donors give one-time donations and recurring commitments, and may be linked to entities (recipients) via sponsorships. Standardized profile columns (first_name, phone, address, etc.) coexist with arbitrary custom fields stored in `json_fields` and defined per `hysform_id`. The `username`/`email`/`password` columns also let donors sign in to the donor portal. required: - id - client_id properties: id: description: Internal donor ID. type: integer format: int64 example: 12345 client_id: description: >- Owning Gratona client (multi-tenant scope). All donor queries MUST filter by this. type: integer format: int64 example: 207 hysform_id: description: >- HysForm that defines this donor's profile fields (custom + standardized) — controls which keys appear in `json_fields`. type: integer format: int64 example: 42 nullable: true donorprogram_id: description: >- Program the donor signed up under, if applicable. Mostly informational. type: integer format: int64 example: 11 nullable: true household_id: description: >- Household this donor is linked to, when joint giving / partner records are tracked together. type: integer format: int64 example: 88 nullable: true type: description: >- Donor entity type. `organization` donors use `organization_name` instead of first/last. type: string enum: - individual - organization example: individual nullable: true username: description: >- Login username for the donor portal. Must be unique across donors when set. type: string example: janedoe nullable: true email: description: Donor email — used for receipts, statements, and donor-portal login. type: string format: email example: jane@example.com nullable: true organization_name: description: >- For `type=organization` donors. Standardized field; mirrored in `json_fields.organization` for legacy clients. type: string example: Acme Foundation nullable: true first_name: description: Donor first / given name. Standardized field. type: string example: Jane nullable: true last_name: description: Donor last / family name. Standardized field. type: string example: Doe nullable: true preferred_contact_method: description: How the donor prefers to be contacted. type: string enum: - email - phone - sms - mail example: email nullable: true phone: description: Phone number as entered by the user (display format). type: string example: (555) 123-4567 nullable: true phone_e164: description: >- Phone normalized to E.164 for SMS/dialing. Populated by the phone normalization pipeline. type: string example: '+15551234567' nullable: true can_receive_sms: description: Whether SMS opt-in is granted for this donor. type: boolean example: true street: description: Street address line 1 (standardized). type: string example: 123 Main St nullable: true address_line2: description: Street address line 2 (apartment, unit, suite). type: string example: Apt 4B nullable: true city: description: City. type: string example: Springfield nullable: true state: description: State / region (free-form display value). type: string example: IL nullable: true zip: description: Postal / ZIP code. type: string example: '62704' nullable: true country: description: Country display name. type: string example: United States nullable: true country_code: description: ISO 3166-1 alpha-2 country code. type: string example: US nullable: true subdivision_code: description: ISO 3166-2 country subdivision code. type: string example: US-IL nullable: true json_fields: description: >- Arbitrary custom fields keyed by `hysform_id` configuration. Values are typically strings, but checkbox / multi-select fields may be arrays. Use `hysform_id` to look up the field definitions. type: object nullable: true additionalProperties: true year_to_date: description: >- Cached YTD giving totals (per year and per program), refreshed by background jobs. type: object nullable: true additionalProperties: true has_artifacts: description: Whether the donor has any uploads/photos attached. type: boolean example: false batch_id: description: >- Set when the donor was created via a CSV import batch; ties together donors imported in the same run. type: integer format: int64 example: null nullable: true created_at: type: string format: date-time example: '2025-03-15T19:42:00Z' updated_at: type: string format: date-time example: '2026-01-02T08:11:00Z' deleted_at: description: >- Soft-delete timestamp; donors with a non-null value are excluded from default queries. type: string format: date-time example: null nullable: true 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 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 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.