> ## 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. # Search donors by name (typeahead) > Returns up to 10 donors matching the search query across the donor's indexed standard and custom fields, scoped to the authenticated client and permitted donor forms. Backed by Meilisearch (`Donor::search`) for fast typeahead lookups; empty `search` returns the top 10 by relevance for the empty token. Each result is enriched with resolved display-name, location, and donor-type context. Existing consumers receive the full donor rows; `projection=quick_actions` returns only compact display fields. Requires permission: `donors_view` (also satisfied by `donors_manage` or `donor-all`). ## OpenAPI ````yaml get /admin/donors 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: get: tags: - Donors summary: Search donors by name (typeahead) description: >- Returns up to 10 donors matching the search query across the donor's indexed standard and custom fields, scoped to the authenticated client and permitted donor forms. Backed by Meilisearch (`Donor::search`) for fast typeahead lookups; empty `search` returns the top 10 by relevance for the empty token. Each result is enriched with resolved display-name, location, and donor-type context. Existing consumers receive the full donor rows; `projection=quick_actions` returns only compact display fields. Requires permission: `donors_view` (also satisfied by `donors_manage` or `donor-all`). operationId: 4b7902416377470a578ec74a7d93e3d5 parameters: - name: search in: query description: >- Free-text search string. Sent verbatim to Meilisearch. Defaults to empty string when omitted. required: false schema: type: string example: jane - name: projection in: query description: >- Set to `quick_actions` to return only id, resolved display context, email, and username while preserving broad indexed matching. required: false schema: type: string enum: - quick_actions responses: '200': description: >- Top 10 matching donors. The default response contains full donor rows with normalized display context; `projection=quick_actions` returns the compact privacy-minimized shape. content: application/json: schema: properties: data: type: array items: oneOf: - $ref: '#/components/schemas/DonorSearchResult' - $ref: '#/components/schemas/QuickActionsDonorSearchResult' type: object '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: DonorSearchResult: title: Donor search result description: >- The full donor row returned to existing typeahead consumers, enriched with normalized display context. allOf: - $ref: '#/components/schemas/Donor' - required: - name - display_name_status - donor_type - city_display - state_display properties: name: description: >- Display name resolved from canonical or custom form title fields. type: string example: Jane Doe display_name_status: type: string enum: - resolved - fallback - missing example: resolved donor_type: type: string enum: - INDIVIDUAL - ORGANIZATION example: INDIVIDUAL nullable: true city_display: type: string example: Louisville nullable: true state_display: type: string example: Kentucky nullable: true type: object QuickActionsDonorSearchResult: title: Quick Actions donor search result description: >- Privacy-minimized donor display fields returned when `projection=quick_actions` is requested. required: - id - name - email - username - display_name_status - donor_type - city_display - state_display properties: id: type: integer format: int64 example: 12345 name: description: Display name resolved from canonical or custom form title fields. type: string example: Jane Doe email: type: string format: email example: jane@example.com nullable: true username: type: string example: janedoe nullable: true display_name_status: type: string enum: - resolved - fallback - missing example: resolved donor_type: type: string enum: - INDIVIDUAL - ORGANIZATION example: INDIVIDUAL nullable: true city_display: type: string example: Louisville nullable: true state_display: type: string example: Kentucky 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 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 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.