> ## 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 newly inserted donations for Zapier

> Returns positive, qualified donation records in descending immutable donation-ID order so edits to the gift date do not create a new event. The numeric id is both the deduplication key and cursor. created_after and cursor_created_at are retained compatibility inputs: the current query pages by cursor_id rather than filtering by those date fields.



## OpenAPI

````yaml get /zapier/triggers/donations/created-feed
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/triggers/donations/created-feed:
    get:
      tags:
        - Zapier
      summary: List newly inserted donations for Zapier
      description: >-
        Returns positive, qualified donation records in descending immutable
        donation-ID order so edits to the gift date do not create a new event.
        The numeric id is both the deduplication key and cursor. created_after
        and cursor_created_at are retained compatibility inputs: the current
        query pages by cursor_id rather than filtering by those date fields.
      operationId: 03e14f0fb9acf13d9e31db6caec5d956
      parameters:
        - name: page_size
          in: query
          description: >-
            Page size; defaults to100. Validation:
            nullable|integer|min:1|max:100.
          required: false
          schema:
            description: 'Page size. Validation: nullable|integer|min:1|max:100.'
            type: integer
            maximum: 100
            minimum: 1
            example: 1
            nullable: true
          example: 100
        - name: created_after
          in: query
          description: >-
            Accepted and echoed in metadata; the current query does not apply
            this date as a lower bound. Validation: nullable|date.
          required: false
          schema:
            description: 'Created after. Validation: nullable|date.'
            type: string
            format: date-time
            nullable: true
          example: '2026-10-01T00:00:00Z'
        - name: cursor_created_at
          in: query
          description: >-
            Compatibility timestamp required when cursor_id is supplied; use
            next_cursor.created_at. Validation:
            nullable|required_with:cursor_id|date.
          required: false
          schema:
            description: >-
              Cursor created at. Validation:
              nullable|required_with:cursor_id|date.
            type: string
            format: date-time
            nullable: true
          example: '2026-10-19T10:00:00Z'
        - name: cursor_id
          in: query
          description: >-
            Donation-ID cursor; requires cursor_created_at and restricts results
            to lower donation IDs. Validation:
            nullable|required_with:cursor_created_at|integer|min:1.
          required: false
          schema:
            description: >-
              Cursor id. Validation:
              nullable|required_with:cursor_created_at|integer|min:1.
            type: integer
            minimum: 1
            example: 1
            nullable: true
          example: 12345
        - name: donor_id
          in: query
          description: 'Restrict the feed to this donor. Validation: nullable|integer.'
          required: false
          schema:
            description: >-
              Donor who owns the gift or commitment. Validation:
              nullable|integer.
            type: integer
            example: 12345
            nullable: true
          example: 12345
        - name: payment_source
          in: query
          description: >-
            Choose all qualified gifts or the supported offline payment methods.
            Validation: nullable|string|in:all,offline.
          required: false
          schema:
            description: 'Payment source. Validation: nullable|string|in:all,offline.'
            type: string
            enum:
              - all
              - offline
              - null
            nullable: true
          example: all
      responses:
        '200':
          description: Insertion-ordered donation page.
          content:
            application/json:
              schema:
                properties:
                  data:
                    description: Qualified donation insertion events.
                    type: array
                    items:
                      $ref: '#/components/schemas/ZapierCreatedDonationItem'
                  meta:
                    description: Page and compatibility cursor metadata.
                    properties:
                      page_size:
                        description: Requested page size after normalization.
                        type: integer
                        example: 100
                      has_more:
                        description: Whether another page exists.
                        type: boolean
                        example: false
                      created_after:
                        description: Echoed compatibility lower-bound value.
                        type: string
                        nullable: true
                      next_cursor:
                        description: Cursor for the next page, or null on the last page.
                        properties:
                          created_at:
                            description: Creation timestamp to pass as cursor_created_at.
                            type: string
                            example: '2026-10-19T10:00:00Z'
                          id:
                            description: Donation ID to pass as cursor_id.
                            type: integer
                            example: 12345
                        type: object
                        nullable: true
                    type: object
                type: object
        '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:
    ZapierCreatedDonationItem:
      description: >-
        Insertion event projection including giving-source disclosure,
        recognition and combined-payment context.
      properties:
        id:
          description: Existing record identifier in the authenticated organization.
          type: integer
          example: 12345
          nullable: true
        donation_id:
          description: Donation id.
          type: integer
          example: 12345
          nullable: true
        donor_id:
          description: Donor who owns the gift or commitment.
          type: integer
          example: 12345
          nullable: true
        method_id:
          description: Method id.
          type: integer
          example: 12345
          nullable: true
        commitment_id:
          description: Commitment id.
          type: integer
          example: 12345
          nullable: true
        sponsorship_id:
          description: Sponsorship id.
          type: integer
          example: 12345
          nullable: true
        soft_credit_count:
          description: Soft credit count.
          type: integer
          example: 12345
          nullable: true
        type:
          description: Record type accepted by this operation.
          type: integer
          example: 12345
          nullable: true
        is_offline_payment:
          description: Is offline payment.
          type: boolean
          example: false
          nullable: true
        is_recurring_payment:
          description: Is recurring payment.
          type: boolean
          example: false
          nullable: true
        is_tax_deductible:
          description: Whether the recorded gift is tax deductible.
          type: boolean
          example: true
          nullable: true
        is_acknowledged:
          description: Is acknowledged.
          type: boolean
          example: false
          nullable: true
        has_soft_credits:
          description: Has soft credits.
          type: boolean
          example: false
          nullable: true
        one_time:
          description: Compatibility one-time gift indicator.
          type: boolean
          example: false
          nullable: true
        refunded:
          description: Whether the recorded gift has a refund.
          type: boolean
          example: false
          nullable: true
        refundable:
          description: Refundable.
          type: boolean
          example: false
          nullable: true
        is_csv_import:
          description: Is csv import.
          type: boolean
          example: false
          nullable: true
        method:
          description: Stored compatibility payment method identifier.
          type: string
          example: Cash
          nullable: true
        in_kind_category:
          description: In kind category.
          type: string
          example: example
          nullable: true
        settled_at:
          description: Settled at.
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        receipt_sent_at:
          description: Receipt sent at.
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        acknowledgement_status:
          description: Acknowledgement status.
          type: string
          example: example
          nullable: true
        acknowledged_at:
          description: Acknowledged at.
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        acknowledgement_source:
          description: Acknowledgement source.
          type: string
          example: example
          nullable: true
        currency:
          description: >-
            Stored currency value; legacy callers commonly use a currency
            symbol.
          type: string
          example: $
          nullable: true
        transaction_id:
          description: External transaction reference stored with the record.
          type: string
          example: external-payment-001
          nullable: true
        transaction_status:
          description: Recorded settlement status.
          type: string
          example: completed
          nullable: true
        result:
          description: Recorded payment result description.
          type: string
          example: Created via Zapier
          nullable: true
        notes:
          description: Internal description associated with the recorded gift.
          type: string
          example: Offline gift received.
          nullable: true
        tags:
          description: Tag names assigned to the recipient; names cannot contain commas.
          type: string
          example: example
          nullable: true
        date:
          description: Date.
          type: string
          example: example
          nullable: true
        soft_credit_total_amount:
          description: Soft credit total amount.
          type: number
          example: 25
          nullable: true
        deposit_date:
          description: Deposit date.
          nullable: true
        in_honor_of:
          description: In honor of.
          nullable: true
        json_fields:
          description: Custom-field values keyed by the configured form field names.
          nullable: true
        created_at:
          description: Created at.
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          example: '2026-10-20T10:00:00Z'
          nullable: true
        amount:
          description: Individual gift amount in the supplied currency.
          type: number
          example: 25
          nullable: true
        refunded_amount:
          description: Recorded amount already refunded.
          type: number
          example: 0
          nullable: true
        net_amount:
          description: Net amount.
          type: number
          example: 25
          nullable: true
        remaining_refundable_amount:
          description: Remaining refundable amount.
          type: number
          example: 25
          nullable: true
        individual_transaction_amount:
          description: Individual transaction amount.
          type: number
          example: 25
          nullable: true
        payment_transaction_amount:
          description: Payment transaction amount.
          type: number
          example: 25
          nullable: true
        combined_transaction_amount:
          description: Combined transaction amount.
          type: number
          example: 25
          nullable: true
        batched_individual_amount:
          description: Batched individual amount.
          type: number
          example: 25
          nullable: true
        non_batched_transaction_amount:
          description: Non batched transaction amount.
          type: number
          example: 25
          nullable: true
        actual_charged_amount:
          description: Actual charged amount.
          type: number
          example: 25
          nullable: true
        batch_donation_id:
          description: Batch donation id.
          type: integer
          example: 12345
          nullable: true
        batch_id:
          description: Batch id.
          type: integer
          example: 12345
          nullable: true
        batch_count:
          description: Batch count.
          type: integer
          example: 12345
          nullable: true
        is_batched:
          description: Is batched.
          type: boolean
          example: false
          nullable: true
        has_combined_transaction_amount:
          description: Has combined transaction amount.
          type: boolean
          example: false
          nullable: true
        batch_group_id:
          description: Batch group id.
          type: string
          example: example
          nullable: true
        amount_context:
          description: Amount context.
          type: string
          example: example
          nullable: true
        batch_donation_ids:
          description: Numeric donation IDs sharing the combined payment context.
          type: array
          items:
            type: integer
        giving_source:
          description: Giving source.
          type: string
          example: example
          nullable: true
        giving_source_label:
          description: Giving source label.
          type: string
          example: example
          nullable: true
        daf_disclosure:
          description: Daf disclosure.
          type: string
          example: example
          nullable: true
        daf_fund_name:
          description: Daf fund name.
          type: string
          example: example
          nullable: true
        source_reference:
          description: Source reference.
          type: string
          example: example
          nullable: true
        ira_owner_donor_id:
          description: Ira owner donor id.
          type: integer
          example: 12345
          nullable: true
        intermediary_donor_id:
          description: Intermediary donor id.
          type: integer
          example: 12345
          nullable: true
        daf_advisor:
          description: >-
            Disclosed DAF advisor; omitted as null when disclosure prevents
            identification.
          properties:
            id:
              description: Related donor identifier.
              type: integer
              example: 12345
            name:
              description: Resolved donor display name.
              type: string
              example: Jane Doe
          type: object
          nullable: true
        ira_owner:
          description: IRA account owner donor.
          properties:
            id:
              description: Related donor identifier.
              type: integer
              example: 12345
            name:
              description: Resolved donor display name.
              type: string
              example: Jane Doe
          type: object
          nullable: true
        intermediary:
          description: Financial custodian donor.
          properties:
            id:
              description: Related donor identifier.
              type: integer
              example: 12345
            name:
              description: Resolved donor display name.
              type: string
              example: Jane Doe
          type: object
          nullable: true
        processing_fee:
          description: Processing fee.
          type: number
          example: 25
          nullable: true
        platform_fee:
          description: Platform fee.
          type: number
          example: 25
          nullable: true
        amount_excluding_fee:
          description: Amount excluding fee.
          type: number
          example: 25
          nullable: true
        processor_net_amount:
          description: Processor net amount.
          type: number
          example: 25
          nullable: true
        donor_covered_fee:
          description: Donor covered fee.
          type: number
          example: 25
          nullable: true
        processor_fee_currency:
          description: Processor fee currency.
          type: string
          example: example
          nullable: true
        processing_fee_known:
          description: Processing fee known.
          type: boolean
          example: false
          nullable: true
        profile:
          description: >-
            Permissioned resolved donor profile with standard/custom and
            compatibility fields; null when no donor is available.
        donor:
          description: Giving donor summary, or null.
          properties:
            id:
              description: Existing record identifier in the authenticated organization.
              type: integer
              example: 12345
              nullable: true
            hysform_id:
              description: Donor form containing the profile.
              type: integer
              example: 42
              nullable: true
            name:
              description: Name.
              type: string
              example: example
              nullable: true
            email:
              description: Profile email address.
              type: string
              example: jane@example.org
              nullable: true
            is_giving_institution:
              description: Is giving institution.
              type: boolean
              example: false
              nullable: true
          type: object
          nullable: true
        designation:
          description: Resolved recipient/designation metadata.
          properties:
            id:
              description: Existing record identifier in the authenticated organization.
              type: integer
              example: 12345
              nullable: true
            type:
              description: Record type accepted by this operation.
              type: integer
              example: 12345
              nullable: true
            emailset_id:
              description: Emailset id.
              type: integer
              example: 12345
              nullable: true
            program_id:
              description: Program containing the recipient or sponsorship.
              type: integer
              example: 11
              nullable: true
            code:
              description: Code.
              type: string
              example: example
              nullable: true
            name:
              description: Name.
              type: string
              example: example
              nullable: true
            program_name:
              description: Program name.
              type: string
              example: example
              nullable: true
          type: object
        soft_credits:
          description: Recognition credits associated with this gift.
          type: array
          items:
            properties:
              id:
                description: Existing record identifier in the authenticated organization.
                type: integer
                example: 12345
                nullable: true
              donor_id:
                description: Donor who owns the gift or commitment.
                type: integer
                example: 12345
                nullable: true
              type_id:
                description: Type id.
                type: integer
                example: 12345
                nullable: true
              donor_name:
                description: Donor name.
                type: string
                example: example
                nullable: true
              donor_email:
                description: Donor email.
                type: string
                example: example
                nullable: true
              type_key:
                description: Type key.
                type: string
                example: example
                nullable: true
              type:
                description: Record type accepted by this operation.
                type: string
                example: individual
                nullable: true
              notes:
                description: Internal description associated with the recorded gift.
                type: string
                example: Offline gift received.
                nullable: true
              created_at:
                description: Created at.
                type: string
                example: '2026-10-20T10:00:00Z'
                nullable: true
              updated_at:
                description: Updated at.
                type: string
                example: '2026-10-20T10:00:00Z'
                nullable: true
              amount:
                description: Individual gift amount in the supplied currency.
                type: number
                example: 25
                nullable: true
            type: object
      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
    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
  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.