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

# Read handwritten-card workspace settings

> Returns saved defaults, spending governance, catalog counts and Postal Mail balance with separate funding/fulfillment readiness. May create default preference/governance rows; reading does not grant balance. Requires the configured Handwrytten feature (normally handwrytten_mailings). Requires permission: one of access_account_settings, manage_settings, mailings_view, mailings_generate, mailings_manage, manage_email.



## OpenAPI

````yaml get /admin/handwrytten/settings
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:
  /admin/handwrytten/settings:
    get:
      tags:
        - Fundraising
      summary: Read handwritten-card workspace settings
      description: >-
        Returns saved defaults, spending governance, catalog counts and Postal
        Mail balance with separate funding/fulfillment readiness. May create
        default preference/governance rows; reading does not grant balance.
        Requires the configured Handwrytten feature (normally
        handwrytten_mailings). Requires permission: one of
        access_account_settings, manage_settings, mailings_view,
        mailings_generate, mailings_manage, manage_email.
      operationId: stewardshipHandwryttenSettings
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      preference:
                        $ref: '#/components/schemas/StewardshipHandwryttenPreference'
                      operational_readiness:
                        $ref: >-
                          #/components/schemas/StewardshipHandwryttenOperationalReadiness
                      governance:
                        $ref: '#/components/schemas/StewardshipHandwryttenGovernance'
                      catalog_counts:
                        properties:
                          cards:
                            description: Count or cent amount.
                            type: integer
                            example: 100
                            nullable: false
                          fonts:
                            description: Count or cent amount.
                            type: integer
                            example: 100
                            nullable: false
                          inserts:
                            description: Count or cent amount.
                            type: integer
                            example: 100
                            nullable: false
                        type: object
                      credits:
                        $ref: >-
                          #/components/schemas/StewardshipHandwryttenCreditSummary
                      managed_account:
                        properties:
                          configured:
                            description: Workflow state.
                            type: boolean
                            example: true
                        type: object
                    type: object
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The authenticated user lacks access to this workflow or its related
            records.
        '422':
          description: >-
            Provider readiness, source, state, payment or request validation
            failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    StewardshipHandwryttenPreference:
      description: >-
        Customer preference projection; provider keys, account identities and
        raw readiness are omitted.
      properties:
        account_mode:
          type: string
          enum:
            - hys_managed
            - partner_owned
          example: hys_managed
        partner_owned_setup_enabled:
          description: Whether Platform Admin has enabled organization-owned setup.
          type: boolean
          example: true
        account_connected:
          description: Workflow state.
          type: boolean
          example: true
        status:
          description: Stored value.
          type: string
          example: Example
          nullable: false
        test_mode:
          description: >-
            Practice mode; the managed provider account is controlled by
            Gratona.
          type: boolean
          example: true
        default_card_catalog_item_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        default_signer_user_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        default_card_vendor_id:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        default_font_label:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        default_insert_vendor_id:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        catalog_sync_status:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        catalog_sync_error:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        default_sender_address_json:
          oneOf:
            - $ref: '#/components/schemas/StewardshipHandwryttenAddress'
            - type: string
              enum:
                - null
              nullable: true
        default_return_address_json:
          oneOf:
            - $ref: '#/components/schemas/StewardshipHandwryttenAddress'
            - type: string
              enum:
                - null
              nullable: true
        estimated_monthly_volume:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        low_credit_threshold:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        catalog_synced_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        saved_preferences_json:
          description: >-
            Organization defaults, low-balance alert and optional auto_reload
            settings.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
      type: object
    StewardshipHandwryttenOperationalReadiness:
      description: >-
        Funding and fulfillment readiness are separate: practice sending may be
        available while live balance funding is disabled.
      properties:
        status:
          description: Stored value.
          type: string
          example: Example
          nullable: false
        ready:
          description: Workflow state.
          type: boolean
          example: true
        can_purchase_credits:
          description: Workflow state.
          type: boolean
          example: true
        can_submit_orders:
          description: Workflow state.
          type: boolean
          example: true
        fulfillment_enabled:
          description: Workflow state.
          type: boolean
          example: true
        funding_enabled:
          description: Workflow state.
          type: boolean
          example: true
        provider_configured:
          description: Workflow state.
          type: boolean
          example: true
        account_validated:
          description: Workflow state.
          type: boolean
          example: true
        provider_mode_sync_pending:
          description: Workflow state.
          type: boolean
          example: true
        catalog_synced:
          description: Workflow state.
          type: boolean
          example: true
        defaults_configured:
          description: Workflow state.
          type: boolean
          example: true
        sender_configured:
          description: Workflow state.
          type: boolean
          example: true
        webhook_configured:
          description: Workflow state.
          type: boolean
          example: true
        provider_fulfillment_ready:
          description: Null until vendor funding readiness is known.
          type: boolean
          example: true
          nullable: true
        status_sync_strategy:
          type: string
          enum:
            - polling
            - signed_gateway
            - unconfigured
          example: polling
        blocking_reasons:
          type: array
          items:
            type: string
            example: Choose a default card and handwriting style.
        credit_purchase_blocking_reasons:
          type: array
          items:
            type: string
            example: Live Postal Mail sending has not been enabled by Gratona.
      type: object
    StewardshipHandwryttenGovernance:
      description: >-
        Workspace spending/approval rules. Omitted updates preserve existing
        values; defaults enforce suppression and household deduplication,
        require approval above zero cents and observe a 60-day outcome window.
      properties:
        id:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        client_id:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        monthly_cap_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        per_user_monthly_cap_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        low_balance_threshold_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        require_approval_over_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        outcome_window_days:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        updated_by_user_id:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        require_director_for_inserts:
          description: Workflow state.
          type: boolean
          example: true
        enforce_suppression:
          description: Workflow state.
          type: boolean
          example: true
        household_dedupe:
          description: Workflow state.
          type: boolean
          example: true
        require_cass_verification:
          description: Workflow state.
          type: boolean
          example: true
        program_caps_json:
          description: >-
            Program-id keyed caps; cent amounts or objects with cent/dollar cap
            fields.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        campaign_caps_json:
          description: Campaign-key keyed caps.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        created_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    StewardshipHandwryttenCreditSummary:
      properties:
        balance_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        reserved_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        low_balance_threshold_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        low_balance:
          description: Workflow state.
          type: boolean
          example: true
        auto_reload:
          properties:
            enabled:
              description: Workflow state.
              type: boolean
              example: true
            threshold_cents:
              description: Count or cent amount.
              type: integer
              example: 100
              nullable: false
            pack_key:
              description: >-
                Configured pack key; obtain current supported packs from
                available_packs.
              type: string
              example: postal-mail-50
            requires_confirmation:
              description: Workflow state.
              type: boolean
              example: true
          type: object
        available_packs:
          type: array
          items:
            properties:
              key:
                type: string
                example: postal-mail-50
              amount_cents:
                description: Count or cent amount.
                type: integer
                example: 100
                nullable: false
            type: object
        balance_purchase_configured:
          description: Workflow state.
          type: boolean
          example: true
        pending_balance_purchase:
          properties:
            attempt_reference:
              description: Opaque reference for resuming the same pending purchase.
              type: string
              example: Example
              nullable: false
            pack_key:
              description: Stored value.
              type: string
              example: Example
              nullable: true
            amount_cents:
              description: Count or cent amount.
              type: integer
              example: 100
              nullable: false
            payment_status:
              description: Stored value.
              type: string
              example: Example
              nullable: true
            created_at:
              description: Timestamp.
              type: string
              format: date-time
              example: '2026-10-20T12:00:00Z'
              nullable: true
          type: object
          nullable: true
        billing_mode:
          type: string
          enum:
            - managed_wallet
            - provider_direct
          example: managed_wallet
        billing_status:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        pricing_version:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        standard_domestic_price_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        rate_label:
          description: Stored value.
          type: string
          example: Example
          nullable: true
        currency:
          type: string
          example: usd
        current_month:
          properties:
            spent_cents:
              description: Count or cent amount.
              type: integer
              example: 100
              nullable: false
            cards_submitted:
              description: Count or cent amount.
              type: integer
              example: 100
              nullable: false
            top_up_cash_collected_cents:
              description: Count or cent amount.
              type: integer
              example: 100
              nullable: false
            refunded_cents:
              description: Count or cent amount.
              type: integer
              example: 100
              nullable: false
          type: object
        recent_entries:
          description: Up to ten recent entries.
          type: array
          items:
            $ref: '#/components/schemas/StewardshipHandwryttenLedgerEntry'
      type: object
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          type: object
    StewardshipHandwryttenAddress:
      description: >-
        Postal address snapshot. Country representations must agree with the
        active catalog; state/province is required for supported countries that
        require it.
      properties:
        first_name:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        last_name:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        name:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        address1:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        address2:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        street:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        address_line2:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        city:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        state:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        province:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        zip:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        postal_code:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        country:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        country_code:
          description: Postal address field.
          type: string
          example: Example
          nullable: true
        country_id:
          description: >-
            Provider country identifier, resolved against the active
            organization catalog.
          oneOf:
            - type: integer
              example: 1
            - type: string
              example: '1'
            - type: string
              enum:
                - null
              nullable: true
      type: object
      additionalProperties: {}
    StewardshipHandwryttenLedgerEntry:
      properties:
        id:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        credit_delta:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        balance_delta_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        balance_after_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        balance_after_credits:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: true
        amount_cents:
          description: Count or cent amount.
          type: integer
          example: 100
          nullable: false
        entry_type:
          description: Stored value.
          type: string
          example: Example
          nullable: false
        currency:
          type: string
          example: usd
        created_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

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