> ## 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.

# Resolve forms attached to a donor or entity

> Read-only donor-session compatibility endpoint for historical archived updates, formerly called Progress Reports. The `session_id` header must identify a logged-in donor in the requested client, and entity results are limited to updates created during that donor's current or archived recipient relationship.



## OpenAPI

````yaml get /frontend/get_forms/{type}/{id}/{hysform_id}/{client_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 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:
  /frontend/get_forms/{type}/{id}/{hysform_id}/{client_id}:
    get:
      tags:
        - Donor Portal
      summary: Resolve forms attached to a donor or entity
      description: >-
        Read-only donor-session compatibility endpoint for historical archived
        updates, formerly called Progress Reports. The `session_id` header must
        identify a logged-in donor in the requested client, and entity results
        are limited to updates created during that donor's current or archived
        recipient relationship.
      operationId: 35dabf9bf205a5868639090703e09fce
      parameters:
        - name: type
          in: path
          description: '`donor` or `entity` — which record type the `id` refers to.'
          required: true
          schema:
            type: string
            enum:
              - donor
              - entity
        - name: id
          in: path
          description: Donor or entity id.
          required: true
          schema:
            type: integer
            format: int64
        - name: hysform_id
          in: path
          required: true
          schema:
            type: integer
            format: int64
        - name: client_id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: Form archives matching the authorized donor or recipient lookup.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '404':
          description: Session, profile, form, or donor relationship not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - sessionIdAuth: []
components:
  schemas:
    NotFoundResponse:
      title: NotFoundResponse
      description: >-
        Returned with HTTP 404 when a resource lookup misses (typically because
        the id doesn't exist OR is scoped to a different `client_id`). Note:
        many endpoints intentionally collapse 'not found' and 'forbidden' into a
        single 404 to avoid leaking which records exist in another tenant.
      required:
        - message
      properties:
        message:
          description: >-
            Human-readable message. Often a more specific string like `Donor not
            found` or `Trip not found`.
          type: string
          example: Not Found
        status:
          type: string
          example: error
      type: object
  securitySchemes:
    sessionIdAuth:
      type: apiKey
      description: >-
        Legacy session-id header retained for backwards compatibility with older
        first-party clients. New integrations should prefer bearerAuth or
        apiKeyAuth.
      name: session_id
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.