> ## 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. # Show public add-recipient form configuration > Returns the public field configuration required to add a recipient/entity from a public program page. The controller creates or refreshes a frontend Redis session, loads the program and its HysForm, filters fields to public permissions, and returns program-type settings used by the public add-entity UI. If the program is missing or has no form configured, it returns a legacy 404 error envelope. ## OpenAPI ````yaml get /frontend/add_entity/{client_id}/{program_id}/{session_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/add_entity/{client_id}/{program_id}/{session_id}: get: tags: - Public summary: Show public add-recipient form configuration description: >- Returns the public field configuration required to add a recipient/entity from a public program page. The controller creates or refreshes a frontend Redis session, loads the program and its HysForm, filters fields to public permissions, and returns program-type settings used by the public add-entity UI. If the program is missing or has no form configured, it returns a legacy 404 error envelope. operationId: showPublicAddEntityForm parameters: - name: client_id in: path description: Client id that owns the program and public entity form. required: true schema: type: integer example: 207 - name: program_id in: path description: Program id whose `hysform_id` defines the public entity fields. required: true schema: type: integer example: 11 - name: session_id in: path description: >- Optional Redis frontend session id. A new session is created when this one is missing or expired. required: true schema: type: string example: 7f2c8f8d64b8a1d4a9e2 responses: '200': description: Public add-entity form configuration. content: application/json: schema: properties: status: type: string example: success data: properties: session_id: type: string example: 7f2c8f8d64b8a1d4a9e2 client_id: type: integer example: 207 program: $ref: '#/components/schemas/Program' fields: description: >- Public fields from the program HysForm, ordered by field order. type: array items: type: object program_data: description: >- Program type settings returned by `Entity::getProgramTypeData()`. type: object enable_public_add_entity_search: description: >- Program setting flag that enables public recipient search before creating a new recipient. type: string example: '1' nullable: true type: object type: object '404': description: Program was not found or has no HysForm configured. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' security: [] components: schemas: Program: title: Program description: >- A program (a.k.a. campaign) groups entities, donor profile forms, settings, and email/SMS template sets. Programs form a hierarchy via the Cartalyst nested-set pattern (`lft`/`rgt`/`tree`). The two HysForm references differentiate the donor profile form (`donor_hysform_id`) from the entity / sponsorship profile form (`hysform_id`). required: - id - client_id - name properties: id: description: Internal program ID. type: integer format: int64 example: 11 client_id: description: Owning Gratona client. type: integer format: int64 example: 207 name: description: Human-readable program name. type: string example: Child Sponsorship 2026 type: description: >- Program type — `sponsorship`, `contribution`, `number of sponsors`, `campaign`, etc. Determines which UI flows are available. type: string example: Contribution nullable: true prefix: description: Receipt / commitment number prefix. type: string example: CS-2026 nullable: true link_id: description: >- Optional parent program ID; used for sub-program linking outside the nested-set tree. type: integer format: int64 example: null nullable: true hysform_id: description: >- HysForm defining the entity (recipient) profile fields for this program. type: integer format: int64 example: 42 donor_hysform_id: description: >- HysForm defining the donor profile fields for donors signing up under this program. type: integer format: int64 example: 43 setting_id: description: >- Settings record holding program-specific configuration (display options, public page copy, etc.). type: integer format: int64 example: 87 nullable: true emailset_id: description: Email template set used for automated emails on this program. type: integer format: int64 example: 14 nullable: true smsset_id: description: SMS template set used for automated SMS on this program. type: integer format: int64 example: null nullable: true lft: description: >- Nested-set left boundary (Cartalyst). Used for tree ordering — do not edit directly. type: integer example: 1 rgt: description: Nested-set right boundary (Cartalyst). type: integer example: 8 tree: description: Nested-set tree id. type: integer example: 1 created_at: type: string format: date-time example: '2025-01-01T00:00:00Z' updated_at: type: string format: date-time example: '2025-12-31T23:00:00Z' deleted_at: type: string format: date-time example: null nullable: true type: object 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.