> ## 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 a generated mailing > Returns the organization compact generated mailing, template/run summary and artifact paths after checking current storage availability. Does not expose rendered HTML or frozen address/merge snapshots. Requires permission: one of mailings_view, mailings_generate, mailings_manage, manage_email, reports_view, reports_manage. ## OpenAPI ````yaml get /admin/mailings/{id} 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/mailings/{id}: get: tags: - Communications summary: Read a generated mailing description: >- Returns the organization compact generated mailing, template/run summary and artifact paths after checking current storage availability. Does not expose rendered HTML or frozen address/merge snapshots. Requires permission: one of mailings_view, mailings_generate, mailings_manage, manage_email, reports_view, reports_manage. operationId: communicationsMailingShow parameters: - name: id in: path description: Id in the current organization. required: true schema: type: integer example: 42 responses: '200': description: Operation result. content: application/json: schema: properties: data: $ref: '#/components/schemas/CommunicationsGeneratedMailing' 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. '404': description: The generated mailing is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: CommunicationsGeneratedMailing: description: >- Compact generated record with template/run information. List artifact flags reflect persisted Upload rows; detail flags probe storage. Artifact endpoints remain authoritative. properties: id: description: Organization-owned record identifier. type: integer example: 42 nullable: false mailing_run_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true mailing_template_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false template_id: description: Organization-owned record identifier. type: integer example: 42 nullable: false donor_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true entity_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true donor_entity_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true household_id: description: Organization-owned record identifier. type: integer example: 42 nullable: true mailing_template_name: description: Serialized value. type: string example: Example nullable: false template_name: description: Serialized value. type: string example: Example nullable: false scope_type: description: Serialized value. type: string example: Example nullable: false template_preset_key: description: Serialized value. type: string example: Example nullable: true recipient_name: description: Serialized value. type: string example: Example nullable: true run_status: description: Serialized value. type: string example: Example nullable: true run_source_type: description: Serialized value. type: string example: Example nullable: true delivery_recipient: description: Serialized value. type: string example: Example nullable: true skip_reason: description: Serialized value. type: string example: Example nullable: true error_message: description: Serialized value. type: string example: Example nullable: true delivery_error_message: description: Serialized value. type: string example: Example nullable: true run_created_date: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true created_at: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true run_completed_at: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true delivered_at: type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true run_total_items: type: integer example: 1 nullable: true run_ready_items: type: integer example: 1 nullable: true run_skipped_items: type: integer example: 1 nullable: true run_failed_items: type: integer example: 1 nullable: true status: type: string example: ready label_layout_preset: type: string enum: - single_label - a4_sheet - a3_sheet - letter_85x11_1_up - letter_4x2_10_up - letter_2625x1_30_up - letter_3x2_10_up - null example: single_label nullable: true delivery_mode: type: string example: none delivery_status: type: string example: not_requested run_delivery_status: type: string example: not_requested nullable: true warning_json: type: array items: oneOf: - type: string - $ref: '#/components/schemas/CommunicationsMailingWarning' nullable: true warnings: type: array items: oneOf: - type: string - $ref: '#/components/schemas/CommunicationsMailingWarning' nullable: true has_letter_artifact: type: boolean example: true has_label_artifact: type: boolean example: true has_label_sheet_artifact: type: boolean example: true has_download_artifact: type: boolean example: true has_print_artifact: type: boolean example: true has_run_zip_artifact: type: boolean example: true letter_url: description: >- API path without the version prefix; call the corresponding documented v1 endpoint. type: string example: /admin/mailings/42/artifact/letter nullable: true label_url: description: >- API path without the version prefix; call the corresponding documented v1 endpoint. type: string example: /admin/mailings/42/artifact/letter nullable: true label_sheet_url: description: >- API path without the version prefix; call the corresponding documented v1 endpoint. type: string example: /admin/mailings/42/artifact/letter nullable: true download_url: description: >- API path without the version prefix; call the corresponding documented v1 endpoint. type: string example: /admin/mailings/42/artifact/letter nullable: true print_url: description: >- API path without the version prefix; call the corresponding documented v1 endpoint. type: string example: /admin/mailings/42/artifact/letter nullable: true run_zip_url: description: >- API path without the version prefix; call the corresponding documented v1 endpoint. type: string example: /admin/mailings/42/artifact/letter nullable: true 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 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 CommunicationsMailingWarning: description: >- Structured tax-summary warning; ordinary mailing address warnings are plain strings. properties: code: type: string example: review_required count: type: integer example: 1 blocking: type: boolean example: true message: type: string example: This tax summary needs review. 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.