> ## 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. # Get a public event page > Returns public registration information, inventory, form policy, payment choices and privacy-filtered location. Invite-only pages require an invitation capability or a valid waitlist offer; inaccessible events return 404. Search and caching headers follow event visibility. ## OpenAPI ````yaml get /frontend/public/events/{clientSlugOrId}/{eventSlug} 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: /frontend/public/events/{clientSlugOrId}/{eventSlug}: get: tags: - Events summary: Get a public event page description: >- Returns public registration information, inventory, form policy, payment choices and privacy-filtered location. Invite-only pages require an invitation capability or a valid waitlist offer; inaccessible events return 404. Search and caching headers follow event visibility. operationId: PublicEventController_show parameters: - name: X-Event-Invitation in: header description: >- Invitation capability required to reach an invite-only event; invite_token input is an alternative. required: false schema: type: string example: issued-invitation-token example: issued-invitation-token - name: X-Event-Waitlist-Offer in: header description: >- An active waitlist offer can authorize the invite-only page; waitlist_offer_token input is an alternative. required: false schema: type: string example: issued-offer-token example: issued-offer-token - name: clientSlugOrId in: path description: Public organization slug or numeric ID. required: true schema: type: string example: example-foundation example: example-foundation - name: eventSlug in: path description: Event slug within the organization. required: true schema: type: string example: annual-gala example: annual-gala - name: invite_token in: query description: Invitation capability; X-Event-Invitation is the preferred header. required: false schema: type: string example: issued-invitation-token example: issued-invitation-token - name: waitlist_offer_token in: query description: >- Active waitlist offer capability; X-Event-Waitlist-Offer is accepted. required: false schema: type: string example: issued-offer-token example: issued-offer-token responses: '200': description: Get a public event page completed. content: application/json: schema: $ref: '#/components/schemas/EventApiPublicPage' '404': description: Resource not found in the organization or feature unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' security: [] components: schemas: EventApiPublicPage: properties: name: description: Name. type: string maxLength: 255 example: Annual Gala slug: description: Slug. type: string maxLength: 255 pattern: ^[a-z0-9-]+$ example: annual-gala nullable: true description: description: Description. type: string example: Example nullable: true type: description: Type. type: string maxLength: 80 example: Example nullable: true status: description: Status. type: string enum: - draft - published - registration_open - registration_closed - live - completed - reconciled - archived - null example: draft nullable: true visibility: description: Visibility. type: string enum: - public - unlisted - invite_only - internal - null example: public nullable: true search_indexing_enabled: description: Search indexing enabled. type: boolean example: false nullable: true timezone: description: >- IANA timezone; legacy aliases are accepted except Factory. Omitted values use the organization timezone on creation. type: string maxLength: 64 example: Example nullable: true starts_at: description: Starts at. Date without offset is interpreted in the event timezone. type: string format: date-time example: '2026-12-20T18:00:00Z' nullable: true ends_at: description: >- Ends at. Date without offset is interpreted in the event timezone. Must be at least starts_at. type: string format: date-time example: '2026-12-20T18:00:00Z' nullable: true registration_opens_at: description: >- Registration opens at. Date without offset is interpreted in the event timezone. type: string format: date-time example: '2026-12-20T18:00:00Z' nullable: true registration_closes_at: description: >- Registration closes at. Date without offset is interpreted in the event timezone. type: string format: date-time example: '2026-12-20T18:00:00Z' nullable: true location_name: description: Location name. type: string maxLength: 255 example: Example nullable: true location_address: description: Location address. type: string example: Example nullable: true public_location_mode: description: Public location mode. type: string enum: - hidden - summary - venue_only - full - null example: hidden nullable: true public_location_summary: description: Public location summary. type: string maxLength: 255 example: Example nullable: true registration_identity_mode: description: Registration identity mode. type: string enum: - minimal_rsvp - organization_donor_form - custom_event_fields - null example: minimal_rsvp nullable: true virtual_url: description: Always null in the public page projection. type: string nullable: true capacity: description: Capacity. type: integer minimum: 1 example: 1 nullable: true settings: properties: show_sponsors: description: Show sponsors. type: boolean example: false nullable: true allow_donation_addon: description: Allow donation addon. type: boolean example: false nullable: true allow_recurring_gift_ask: description: Allow recurring gift ask. type: boolean example: false nullable: true allow_child_sponsorship_ask: description: Allow child sponsorship ask. type: boolean example: false nullable: true cover_fees_enabled: description: Cover fees enabled. type: boolean example: false nullable: true processing_percentage: description: Processing percentage. type: number maximum: 100 minimum: 0 example: 1 nullable: true auction_enabled: description: Auction enabled. type: boolean example: false nullable: true show_sponsor_packages: description: Whether sponsorship packages are shown. type: boolean example: false type: object id: description: Event ID. type: integer example: 42 client_id: description: Organization ID. type: integer example: 42 cover_image_url: description: Cover image URL. type: string example: Example nullable: true currency: description: ISO currency code. type: string example: USD location: properties: mode: description: Internal or public location policy. type: string example: internal label: description: Display location. type: string example: Example nullable: true venue: description: Venue name. type: string example: Example nullable: true address: description: Street address. type: string example: Example nullable: true map_allowed: description: Whether the address may be used for maps. type: boolean example: false type: object published_at: description: First publication time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true completed_at: description: Completion time. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true registered_attendee_count: description: Registered non-cancelled attendee count, when loaded. type: integer example: 42 nullable: true checked_in_count: description: Checked-in count, when loaded. type: integer example: 42 nullable: true readiness: description: Empty in public projection. type: array items: type: string people: type: array items: properties: id: description: Event person ID. type: integer example: 42 role: description: Event role. type: string enum: - host - co_host - worship_leader - speaker - volunteer - table_host - internal_owner example: host display_name: description: Resolved display name. type: string example: Example nullable: true public_visibility: description: Whether shown publicly. type: boolean example: false sort_order: description: Display order. type: integer example: 42 type: object ticket_types: type: array items: type: object allOf: - $ref: '#/components/schemas/EventApiTicketType' - properties: remaining_quantity: description: Remaining inventory; null means unbounded. type: integer example: 42 nullable: true availability: properties: state: description: Saleability state. type: string example: available reason: description: Unavailable reason, otherwise null. type: string example: Sales have not started. nullable: true type: object type: object questions: description: Setup rows; empty in compact mode. type: array items: $ref: '#/components/schemas/EventApiQuestion' sponsor_packages: type: array items: type: object allOf: - $ref: '#/components/schemas/EventApiSponsorPackage' - properties: remaining_quantity: description: Remaining package inventory; null means unbounded. type: integer example: 42 nullable: true availability: properties: state: description: Saleability state. type: string example: available reason: description: Unavailable reason, otherwise null. type: string example: Sales have not started. nullable: true type: object type: object tables: description: Empty in public projection. type: array items: type: string auction_items: type: array items: type: object allOf: - $ref: '#/components/schemas/EventApiAuctionItem' - properties: remaining_quantity: description: Remaining item inventory; null means unbounded. type: integer example: 42 nullable: true current_bid: description: Current high bid amount. type: number example: 100 minimum_bid: description: Minimum next bid amount. type: number example: 110 bid_count: description: Qualifying bid count. type: integer example: 42 type: object availability: $ref: '#/components/schemas/EventApiAvailability' registration_v2_enabled: description: Whether grouped registration features are enabled. type: boolean example: false remove_branding: description: Whether organization attribution is removed. type: string enum: - '0' - '1' example: '0' branding_program_id: description: Branding program context. type: integer example: 42 nullable: true resolved_app_brand: description: Resolved app brand. type: string example: gratona resolved_app_brand_source: description: Source of brand resolution. type: string example: client organization: properties: id: description: Organization ID. type: integer example: 42 name: description: Organization name. type: string example: Example Foundation type: object organization_name: description: Organization name. type: string example: Example Foundation accepts_registrations: description: True only for an open, non-preview event. type: boolean example: false preview: properties: active: description: Preview is active. type: boolean example: true banner: description: Preview notice. type: string example: Preview — this event is not live. Registration is disabled. writes_enabled: description: Preview writes are disabled. type: boolean example: false type: object nullable: true conversion_paths: properties: program_id: description: Related program id. type: integer example: 42 nullable: true recipient_sponsorship_program_id: description: Related recipient sponsorship program id. type: integer example: 42 nullable: true campaign_program_id: description: Related campaign program id. type: integer example: 42 nullable: true recipient_group_entity_id: description: Related recipient group entity id. type: integer example: 42 nullable: true designation_entity_id: description: Related designation entity id. type: integer example: 42 nullable: true trip_id: description: Related trip id. type: integer example: 42 nullable: true type: object form_context: properties: identity_mode: description: Returned for minimal RSVP mode. type: string example: minimal_rsvp program_id: description: Form-specific program context. type: integer example: 42 nullable: true hysform_id: description: Resolved donor form ID. type: integer example: 42 nullable: true show_standardized_fields: description: Whether standardized identity fields apply. type: boolean example: false signup_fields: type: array items: properties: id: description: Donor field ID. type: integer example: 42 field_key: description: Submission property key. type: string example: favorite_program field_label: description: Readable field label. type: string example: Favorite program field_type: description: Form control type. type: string example: hysText field_data: description: Field options/serialized configuration. type: string example: Example nullable: true required: description: Required flag. type: integer example: 1 field_order: description: Display order. type: integer example: 42 donor_type: description: Applicable donor type. type: string example: Example nullable: true conditional_display_rule: description: Optional conditional display configuration. type: object additionalProperties: true type: object visible_standard_field_keys: type: array items: description: Visible standardized field key. type: string example: email required_standard_field_keys: type: array items: description: Required standardized field key. type: string example: email standard_field_contract: description: >- Current standard-field policy contract and revision; null when standardized fields are disabled. type: object nullable: true additionalProperties: true minimal_fields: description: Minimal RSVP mode only. type: array items: properties: key: description: Minimal identity field key. type: string example: first_name label: description: Field label. type: string example: First name required: description: Whether required. type: boolean example: false type: object type: object payment_gateways: description: Empty in previews. type: array items: properties: key: description: Gateway selector key. type: string enum: - stripe - paypal - authorizenet example: stripe label: description: Display label. type: string example: Credit card gateway: description: Stored gateway identifier. type: string example: Stripe available: description: Whether gateway is available. type: boolean example: false public_checkout_supported: description: Whether browser checkout is supported. type: boolean example: false message: description: Unavailable explanation. type: string example: Example nullable: true payment_availability: description: Stripe Connect availability details; Stripe only. type: object additionalProperties: true type: object payment_methods: description: Empty in previews. type: array items: properties: key: description: Payment selector key. type: string example: stripe kind: description: Payment flow kind. type: string enum: - gateway - offline example: gateway payment_method: description: Method used in registration. type: string example: card gateway: description: Gateway key, or null for check. type: string example: stripe nullable: true label: description: Display label. type: string example: Credit card available: description: Whether selectable. type: boolean example: false message: description: Availability explanation. type: string example: Example nullable: true instructions: description: Check-payment instructions. type: string example: Example nullable: true type: object metadata: properties: title: description: Page title. type: string example: Annual Gala | Example Foundation description: description: Plain-text description limited to 160 characters. type: string example: Join our annual gala. canonical: description: Canonical URL; null for preview/invite-only/internal. type: string example: Example nullable: true robots: description: Search crawler policy. type: string example: index,follow open_graph: description: >- Website Open Graph title, description, URL and image; null for previews or invite-only events. type: object nullable: true additionalProperties: true json_ld: description: >- schema.org Event, offers, organizer and privacy-filtered location; present only when publicly indexable. type: object nullable: true additionalProperties: true type: object 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 EventApiTicketType: properties: id: description: Id. type: integer example: 1 client_id: description: Client id. type: integer example: 1 nullable: false event_id: description: Event id. type: integer example: 1 nullable: false name: description: Name. type: string example: Annual Gala nullable: false code: description: Code. type: string example: Example nullable: true description: description: Description. type: string example: Example nullable: true price: description: Price serialized as a decimal string. type: string example: '25.00' nullable: false fair_market_value: description: Fair market value serialized as a decimal string. type: string example: '25.00' nullable: false quantity_available: description: Quantity available. type: integer example: 1 nullable: true quantity_sold: description: Quantity sold. type: integer example: 1 nullable: false quantity_reserved: description: Quantity reserved. type: integer example: 1 nullable: false admissions_per_unit: description: Admissions per unit. type: integer example: 1 nullable: false registration_group_kind: description: Registration group kind. type: string example: Example nullable: false group_label_prompt: description: Group label prompt. type: string example: Example nullable: true attendee_details_timing: description: Attendee details timing. type: string example: Example nullable: false waitlist_enabled: description: Waitlist enabled. type: boolean example: false nullable: false min_per_order: description: Min per order. type: integer example: 1 nullable: false max_per_order: description: Max per order. type: integer example: 1 nullable: true attendee_details_required: description: Attendee details required. type: boolean example: false nullable: false is_active: description: Is active. type: boolean example: false nullable: false visibility: description: Visibility. type: string enum: - public - private example: public nullable: false sale_starts_at: description: Sale starts at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true sale_ends_at: description: Sale ends at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true sort_order: description: Sort order. type: integer example: 1 nullable: false settings: description: Settings. type: object nullable: true additionalProperties: true created_at: description: Created at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object EventApiQuestion: properties: id: description: Id. type: integer example: 1 client_id: description: Client id. type: integer example: 1 nullable: false event_id: description: Event id. type: integer example: 1 nullable: false scope: description: Scope. type: string example: Example nullable: false field_key: description: Field key. type: string pattern: ^[a-z0-9_\\\\-]+$ example: dietary_preferences nullable: false field_label: description: Field label. type: string example: Dietary preferences nullable: false field_type: description: Field type. type: string example: Example nullable: false help_text: description: Help text. type: string example: Example nullable: true options: description: Options. type: array items: description: '*.' type: string maxLength: 255 example: Example maxItems: 50 nullable: true applies_to_ticket_type_ids: description: Applies to ticket type ids. type: array items: description: >- *. Referenced record must belong to the authenticated organization and this event. type: integer example: 1 nullable: true required: description: Required. type: boolean example: false nullable: false is_active: description: Is active. type: boolean example: false nullable: false sort_order: description: Sort order. type: integer example: 1 nullable: false created_at: description: Created at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object EventApiSponsorPackage: properties: id: description: Id. type: integer example: 1 client_id: description: Client id. type: integer example: 1 nullable: false event_id: description: Event id. type: integer example: 1 nullable: false name: description: Name. type: string example: Annual Gala nullable: false tier: description: Tier. type: string example: Example nullable: true description: description: Description. type: string example: Example nullable: true price: description: Price serialized as a decimal string. type: string example: '25.00' nullable: false fair_market_value: description: Fair market value serialized as a decimal string. type: string example: '25.00' nullable: false included_tickets: description: Included tickets. type: integer example: 1 nullable: false included_tables: description: Included tables. type: integer example: 1 nullable: false quantity_available: description: Quantity available. type: integer example: 1 nullable: true quantity_sold: description: Quantity sold. type: integer example: 1 nullable: false quantity_reserved: description: Quantity reserved. type: integer example: 1 nullable: false visibility: description: Visibility. type: string enum: - public - private example: public nullable: false deliverables_template: description: Deliverables template. type: array items: type: string nullable: true settings: description: Settings. type: object nullable: true additionalProperties: true is_active: description: Is active. type: boolean example: false nullable: false sort_order: description: Sort order. type: integer example: 1 nullable: false created_at: description: Created at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object EventApiAuctionItem: properties: id: description: Id. type: integer example: 1 client_id: description: Client id. type: integer example: 1 nullable: false event_id: description: Event id. type: integer example: 1 nullable: false name: description: Name. type: string example: Annual Gala nullable: false description: description: Description. type: string example: Example nullable: true fair_market_value: description: Fair market value serialized as a decimal string. type: string example: '25.00' nullable: false starting_bid: description: Starting bid serialized as a decimal string. type: string example: '25.00' nullable: false buy_now_price: description: Buy now price serialized as a decimal string. type: string example: '25.00' nullable: true quantity_available: description: Quantity available. type: integer example: 1 nullable: true quantity_sold: description: Quantity sold. type: integer example: 1 nullable: false status: description: Status. type: string enum: - draft - open - closed - fulfilled - cancelled example: draft nullable: false visibility: description: Visibility. type: string enum: - public - private example: public nullable: false sort_order: description: Sort order. type: integer example: 1 nullable: false settings: description: Settings. type: object nullable: true additionalProperties: true created_at: description: Created at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true bid_summary: properties: active_bid_count: description: active bid count. type: integer example: 42 awarded_count: description: awarded count. type: integer example: 42 bid_count: description: bid count. type: integer example: 42 purchased_count: description: purchased count. type: integer example: 42 high_bid: description: high bid. type: number example: 0 settled_total: description: settled total. type: number example: 0 last_bid_at: description: last bid at. type: string example: Example nullable: true leader_at: description: leader at. type: string example: Example nullable: true leader_signature: description: leader signature. type: string example: Example nullable: true leader_status: description: leader status. type: string example: Example nullable: true winner: description: winner. type: string example: Example nullable: true type: object type: object EventApiAvailability: properties: state: description: Registration lifecycle state. type: string enum: - draft - scheduled - open - closed - sold_out - payment_unavailable - archived example: draft reason: description: Readable state reason. type: string example: Registration is open. boundary_at: description: Next opening/closing boundary, when applicable. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.