> ## 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 forms for Zapier > Reads the forms.list primitive without field definitions, applies a case-insensitive name match to that returned batch, and truncates the result to limit. Matching occurs after the primitive limited catalog is loaded. An ID lookup that finds no record returns200 with data=[] and count=0. ## OpenAPI ````yaml get /zapier/searches/forms 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: /zapier/searches/forms: get: tags: - Zapier summary: Search forms for Zapier description: >- Reads the forms.list primitive without field definitions, applies a case-insensitive name match to that returned batch, and truncates the result to limit. Matching occurs after the primitive limited catalog is loaded. An ID lookup that finds no record returns200 with data=[] and count=0. operationId: 0899d209ae60870dc7c87e8c39b05e12 parameters: - name: type in: query description: >- Record type accepted by this operation. Validation: nullable|string|in:donor,entity,submit. required: false schema: description: >- Record type accepted by this operation. Validation: nullable|string|in:donor,entity,submit. type: string enum: - donor - entity - submit - null example: donor nullable: true example: donor - name: query in: query description: 'Text used to search matching records. Validation: nullable|string.' required: false schema: description: 'Text used to search matching records. Validation: nullable|string.' type: string example: Jane nullable: true example: Jane - name: limit in: query description: >- Maximum search records to return; default25. Validation: nullable|integer|min:1|max:100. required: false schema: description: >- Maximum search records to return; default25. Validation: nullable|integer|min:1|max:100. type: integer maximum: 100 minimum: 1 example: 25 nullable: true example: 25 responses: '200': description: Matching record projections. content: application/json: schema: required: - data - count properties: data: description: >- Matching records. An ID lookup with no record returns an empty array. type: array items: $ref: '#/components/schemas/ZapierFormSearchRecord' count: description: Number of returned records. type: integer example: 1 type: object '400': description: The selected primitive rejected the operation. content: application/json: schema: $ref: '#/components/schemas/V3PrimitiveResult' '401': description: The API credential is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- Workspace access, primitive scope, feature availability or Gratona permissions do not permit this request. content: application/json: schema: $ref: '#/components/schemas/V3AccessDenied' '422': description: The transport or selected primitive rejected input validation. content: application/json: schema: $ref: '#/components/schemas/ZapierValidationFailure' security: - bearerAuth: [] - apiKeyAuth: [] servers: - url: https://api.gratona.com/v3 description: Gratona V3 automation API components: schemas: ZapierFormSearchRecord: description: >- Projection returned by the selected search/list or ID-lookup primitive. Additional record fields vary by lookup mode and caller permissions. properties: id: description: Existing record identifier in the authenticated organization. type: integer example: 12345 nullable: true name: description: Name. type: string example: example nullable: true type: description: Record type accepted by this operation. type: string example: individual nullable: true created_at: description: Created at. type: string example: '2026-10-20T10:00:00Z' nullable: true use_standardized_fields: description: Use standardized fields. type: boolean example: false nullable: true type: object V3PrimitiveResult: description: >- The PrimitiveResult envelope serialized by primitive invocation and validation. required: - success - data - errors - warnings - meta properties: success: description: Whether the selected primitive succeeded. type: boolean example: true data: description: >- Operation-specific JSON result, or null on failure. Its schema is returned by primitive discovery. nullable: true errors: description: Domain errors or validation field errors. type: array items: properties: code: description: Machine-readable error code. type: string example: VALIDATION_ERROR message: description: Domain error explanation when present. type: string example: Record was not found. details: description: Additional domain-specific error details. field: description: Invalid input field for validation errors. type: string example: donor_id messages: description: Validation messages for that field. type: array items: type: string type: object warnings: description: Non-fatal operation warnings. type: array items: type: string meta: description: >- Operation metadata; may contain status, dry_run, replay information or pagination. Empty metadata serializes as an empty array. 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 V3AccessDenied: description: >- Scope/primitive denials or the authentication middleware workspace-access denial. oneOf: - $ref: '#/components/schemas/V3DiscoveryError' - $ref: '#/components/schemas/ErrorResponse' ZapierValidationFailure: description: >- Laravel transport validation map or primitive validation/domain error envelope. oneOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/V3PrimitiveResult' V3DiscoveryError: description: >- V3 discovery errors; primitive failures may additionally include data, warnings and meta. required: - success - errors properties: success: description: False when discovery or authorization fails. type: boolean example: false errors: description: Structured operation errors. type: array items: properties: code: description: Machine-readable failure code. type: string example: INSUFFICIENT_SCOPE message: description: Human-readable explanation. type: string example: Required scope is missing. required_scope: description: Required scope when reported by the guard. type: string example: schema:read available_scopes: description: Credential scopes when reported by the schema guard. type: array items: type: string required_permission_groups: description: Permission alternatives grouped by required access boundary. type: array items: type: array items: type: string type: object 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 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.