> ## 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. # List handwritten-card orders > Returns newest-first order projections with approval/status/queue-state filters and current operational readiness. Practice verification appears as verification_complete in item status. Requires the configured Handwrytten feature (normally handwrytten_mailings). Requires permission: one of mailings_view, mailings_generate, mailings_manage, manage_email. ## OpenAPI ````yaml get /admin/handwrytten/queue 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/queue: get: tags: - Fundraising summary: List handwritten-card orders description: >- Returns newest-first order projections with approval/status/queue-state filters and current operational readiness. Practice verification appears as verification_complete in item status. Requires the configured Handwrytten feature (normally handwrytten_mailings). Requires permission: one of mailings_view, mailings_generate, mailings_manage, manage_email. operationId: stewardshipHandwryttenQueue parameters: - name: approval_status in: query description: 'Approval status. Validation: nullable, string, max:32.' required: false schema: type: string maxLength: 32 nullable: true example: Approval Status - name: status in: query description: 'Status. Validation: nullable, string, max:32.' required: false schema: type: string maxLength: 32 nullable: true example: all - name: queue_state in: query description: >- Queue state. Validation: nullable, string; allowed values: needs_approval, ready_to_send, in_progress, history, needs_attention. required: false schema: type: string enum: - needs_approval - ready_to_send - in_progress - history - needs_attention - null nullable: true example: needs_approval - name: per_page in: query description: 'Per page. Validation: nullable, integer, min:1, max:100.' required: false schema: type: integer maximum: 100 minimum: 1 nullable: true example: 1 - name: page in: query description: Result page. required: false schema: type: integer minimum: 1 example: 1 responses: '200': description: Operation result. content: application/json: schema: properties: data: description: Laravel LengthAwarePaginator representation. properties: current_page: description: Count or cent amount. type: integer example: 100 nullable: false data: type: array items: $ref: '#/components/schemas/StewardshipHandwryttenOrder' first_page_url: description: Stored value. type: string example: Example nullable: true from: description: Count or cent amount. type: integer example: 100 nullable: true last_page: description: Count or cent amount. type: integer example: 100 nullable: false last_page_url: description: Stored value. type: string example: Example nullable: true links: type: array items: properties: url: description: Stored value. type: string example: Example nullable: true label: description: Stored value. type: string example: Example nullable: true active: description: Workflow state. type: boolean example: true type: object next_page_url: description: Stored value. type: string example: Example nullable: true path: description: Stored value. type: string example: Example nullable: true per_page: description: Count or cent amount. type: integer example: 100 nullable: false prev_page_url: description: Stored value. type: string example: Example nullable: true to: description: Count or cent amount. type: integer example: 100 nullable: true total: description: Count or cent amount. type: integer example: 100 nullable: false type: object operational_readiness: $ref: >- #/components/schemas/StewardshipHandwryttenOperationalReadiness 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: Request validation failed. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: StewardshipHandwryttenOrder: description: >- Customer order projection. Practice test_submitted status is presented as verification_complete; provider state, request payloads, credentials and margin are omitted. properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: true donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true generated_mailing_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true mailing_run_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true fundraising_work_item_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true status: description: Stored value. type: string example: Example nullable: true approval_status: description: Stored value. type: string example: Example nullable: true vendor_order_id: description: Stored value. type: string example: Example nullable: true vendor_status: description: Stored value. type: string example: Example nullable: true card_name: description: Stored value. type: string example: Example nullable: true card_vendor_id: description: Stored value. type: string example: Example nullable: true font_label: description: Stored value. type: string example: Example nullable: true insert_vendor_id: description: Stored value. type: string example: Example nullable: true message_resolved: description: Stored value. type: string example: Example nullable: true created_by_user_name: description: Stored value. type: string example: Example nullable: true submitted_at: description: Timestamp. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true requested_send_date: description: Requested mailing date. type: string format: date example: '2026-10-20' nullable: true recipient_address_snapshot_json: $ref: '#/components/schemas/StewardshipHandwryttenAddress' price: $ref: '#/components/schemas/StewardshipHandwryttenPrice' governance_flags_json: properties: blocking_reasons: type: array items: type: string example: Missing recipient country. type: object 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 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: {} StewardshipHandwryttenPrice: description: Customer commercial quote; excludes provider cost and margin. properties: billing_mode: type: string enum: - managed_wallet - provider_direct example: managed_wallet pricing_version: description: Stored value. type: string example: Example nullable: true rate_label: description: Stored value. type: string example: Example nullable: true currency: type: string example: usd components: type: array items: properties: key: description: Stored value. type: string example: Example nullable: true label: description: Stored value. type: string example: Example nullable: true amount_cents: description: Count or cent amount. type: integer example: 100 nullable: true type: object total_cents: description: Approved customer total in cents. type: integer example: 100 nullable: false type: object nullable: true 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.