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

# Preview a workspace invitation

> Returns the organization label, masked mailbox and required authentication mode without authenticating the visitor. Invitation must be signed, unexpired, unclaimed and unrevoked; admission must be enabled.



## OpenAPI

````yaml get /workspace-onboarding/invite
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:
  /workspace-onboarding/invite:
    get:
      tags:
        - Workspace
      summary: Preview a workspace invitation
      description: >-
        Returns the organization label, masked mailbox and required
        authentication mode without authenticating the visitor. Invitation must
        be signed, unexpired, unclaimed and unrevoked; admission must be
        enabled.
      operationId: reference_Frontend_WorkspaceOnboardingController_invitePreview
      parameters:
        - name: X-Signup-Invite
          in: header
          description: >-
            Supply a signed invitation using this header or an
            invite/invite_token query or body field. At least one is required;
            body/query values take precedence.
          required: false
          schema:
            type: string
          example: example-signed-invitation
        - name: invite
          in: query
          description: >-
            Supply a signed invitation using this header or an
            invite/invite_token query or body field. At least one is required;
            body/query values take precedence.
          required: false
          schema:
            type: string
          example: example-signed-invitation
        - name: invite_token
          in: query
          description: >-
            Supply a signed invitation using this header or an
            invite/invite_token query or body field. At least one is required;
            body/query values take precedence.
          required: false
          schema:
            type: string
          example: example-signed-invitation
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                required:
                  - status
                  - data
                properties:
                  status:
                    type: string
                    enum:
                      - success
                    example: success
                  data:
                    required:
                      - brand_id
                      - organization_name
                      - email_hint
                      - authentication
                      - expires_at
                    properties:
                      brand_id:
                        type: string
                        example: gratona
                      organization_name:
                        type: string
                        example: Example Nonprofit
                        nullable: true
                      email_hint:
                        type: string
                        example: j***@example.org
                      authentication:
                        type: string
                        enum:
                          - invitation
                          - email_code
                        example: invitation
                      expires_at:
                        type: string
                        format: date-time
                        example: '2026-10-21T12:00:00Z'
                        nullable: true
                    type: object
                type: object
        '401':
          description: An invitation token is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceOnboardingError'
        '404':
          description: Invitation admission is disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceOnboardingError'
        '410':
          description: The invitation is invalid, expired, revoked or claimed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceOnboardingError'
        '429':
          description: The setup request rate limit was reached.
        '503':
          description: Workspace setup or a required service is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceOnboardingError'
      security: []
      servers:
        - url: https://api.gratona.com/v1
          description: Gratona API
components:
  schemas:
    WorkspaceOnboardingError:
      required:
        - status
        - code
        - message
      properties:
        status:
          type: string
          enum:
            - error
          example: error
        code:
          type: string
          example: workspace_onboarding_session_unavailable
        message:
          type: string
          example: This setup session is no longer available. Start again.
      type: object

````

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