> ## 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. # Create the verified workspace and sign in > Requires confirmed setup choices and successful payment-method qualification. Atomically creates the organization, owner, pricing assignment and pinned setup profile, with starter recipes and welcome delivery queued. Claims a single authenticated handoff and burns the resume credential before issuing the ordinary admin session. HTTP409 handoff_requires_sign_in means the workspace is ready and the owner should sign in normally. Existing mailbox accounts receive HTTP200 sign-in routing. ## OpenAPI ````yaml post /workspace-onboarding/{public_id}/finalize 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/{public_id}/finalize: post: tags: - Workspace summary: Create the verified workspace and sign in description: >- Requires confirmed setup choices and successful payment-method qualification. Atomically creates the organization, owner, pricing assignment and pinned setup profile, with starter recipes and welcome delivery queued. Claims a single authenticated handoff and burns the resume credential before issuing the ordinary admin session. HTTP409 handoff_requires_sign_in means the workspace is ready and the owner should sign in normally. Existing mailbox accounts receive HTTP200 sign-in routing. operationId: reference_Frontend_WorkspaceOnboardingController_finalize parameters: - name: X-Workspace-Onboarding-Session in: header description: >- Opaque resume credential returned after mailbox or invitation authentication. It is bound to this setup session and expires or rotates during handoff. required: true schema: type: string maxLength: 64 minLength: 64 example: example-session-token-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - name: public_id in: path description: Public setup-session UUID. required: true schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 responses: '200': description: Operation result. content: application/json: schema: oneOf: - allOf: - $ref: '#/components/schemas/PasswordlessAdminSession' - required: - post_auth_path - onboarding_complete properties: post_auth_path: type: string example: /app/onboarding onboarding_complete: type: boolean example: true type: object - $ref: '#/components/schemas/WorkspaceOnboardingExistingAccount' '401': description: The setup credential or authenticated handoff is unavailable. content: application/json: schema: $ref: '#/components/schemas/WorkspaceOnboardingError' '404': description: Workspace admission is disabled. content: application/json: schema: $ref: '#/components/schemas/WorkspaceOnboardingError' '409': description: >- Setup is not ready, the invitation/session changed, or the completed workspace requires ordinary sign-in. content: application/json: schema: oneOf: - $ref: '#/components/schemas/WorkspaceOnboardingError' - required: - status - code - message - post_auth_path - onboarding_complete properties: status: type: string enum: - failed example: failed code: type: string enum: - workspace_onboarding_handoff_requires_sign_in example: workspace_onboarding_handoff_requires_sign_in message: type: string example: >- Your workspace is ready. Sign in with your email to continue. post_auth_path: type: string example: /app/onboarding onboarding_complete: type: boolean example: true type: object '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: PasswordlessAdminSession: properties: status: type: string example: success client_status: description: Current billing access state. type: string enum: - active - closed - lead - delinquent - due example: active organization: type: string example: Example Nonprofit website: type: string example: https://example.org nullable: true token: description: New administrator bearer access token. Treat as a secret. type: string example: example-access-token org_created_at: type: string example: '2024-06-15T09:50:00Z' last_payment_date: description: Last successful billing payment timestamp, when available. type: string nullable: true last_payment_amount: description: Latest billing payment amount or null. nullable: true monthly_payment: description: Current resolved recurring billing amount. user: $ref: '#/components/schemas/User' plan: description: Resolved billing plan key. type: string example: growth pricing_tier: type: string example: growth nullable: true pricing_quote: type: object additionalProperties: true entitlements: type: object additionalProperties: true permissions: type: object additionalProperties: true access_manifest: type: object additionalProperties: true type: object WorkspaceOnboardingExistingAccount: required: - status - code - data properties: status: type: string enum: - success example: success code: type: string enum: - workspace_onboarding_existing_account example: workspace_onboarding_existing_account data: required: - state - next_action - redirect_path properties: state: type: string enum: - existing_account example: existing_account next_action: type: string enum: - sign_in example: sign_in redirect_path: type: string enum: - /sign-in example: /sign-in type: object type: object 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 User: title: User description: >- An admin user — staff member of a client organization. Authenticates via Laravel Passport (bearer JWT) for the admin web app, and may also issue API keys (via `ApiKey`) for server-to-server integrations. Permissions are stored as JSON keyed by feature; group membership (`group_id`) supplies a baseline permission set on top of the per-user override. required: - id - email - client_id properties: id: description: Internal user ID. type: integer format: int64 example: 1024 email: description: >- User email — also the login identifier. Unique across the whole users table. type: string format: email example: staff@gratona.com first_name: description: Given name. type: string example: Alex nullable: true last_name: description: Family name. type: string example: Morgan nullable: true phone: description: Optional phone number for SMS / call notifications. type: string example: '+15551234567' nullable: true client_id: description: >- Client (tenant) the user belongs to. Stored as string for historical reasons; numeric in practice. type: string example: '207' group_id: description: >- Permission group the user belongs to; supplies baseline permissions before the per-user override. type: integer format: int64 example: 4 nullable: true permissions: description: >- Per-user permission overrides as a JSON map keyed by permission slug. Values are typically the string `1` (granted) or absent. Merged with group permissions at request time. Example: `{group_all: 1, donor-42: 1}`. type: object nullable: true additionalProperties: true onboarding_status: description: >- Onboarding-flow stage marker. `3` = onboarding complete; lower values indicate the user is still in setup. type: string example: '3' nullable: true activated: description: >- Whether the account is activated (email verified / activation code redeemed). type: boolean example: true access_disabled_at: description: >- Administrative disable timestamp. Authorized admin payloads expose it so clients can distinguish disabled access from a pending mailbox-proof invitation. type: string format: date-time example: null nullable: true is_platform_admin: description: >- Server-resolved platform authority. Clients must treat false or missing as no platform authority and must not infer this grant from persisted roles or legacy ids. type: boolean example: false activation_code: description: Pending activation token — null after activation. type: string example: null nullable: true activated_at: type: string format: date-time example: '2024-06-15T10:00:00Z' nullable: true last_login: type: string format: date-time example: '2026-04-29T14:01:00Z' nullable: true email_verified_at: type: string format: date-time example: '2024-06-15T10:00:00Z' nullable: true created_at: type: string format: date-time example: '2024-06-15T09:50:00Z' updated_at: type: string format: date-time example: '2026-04-29T14:01:00Z' type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.