> ## 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. # Queue a recipient worksheet CSV export > Creates an export artifact, queues CSV generation and records the request in Activity. Applies saved views, current program/surface filters, selected fields/order/labels and participation field access; all or0 exports the combined program context. Returns HTTP200 with queued status, not CSV content. Follow export_id through the export status workflow; the returned status_url is a versionless relative API path. Worker failures/delivery are reported asynchronously. Requires permission: one of programs_view, manage_programs, program-all. ## OpenAPI ````yaml post /admin/entities/{program_id}/export 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/entities/{program_id}/export: post: tags: - Recipients summary: Queue a recipient worksheet CSV export description: >- Creates an export artifact, queues CSV generation and records the request in Activity. Applies saved views, current program/surface filters, selected fields/order/labels and participation field access; all or0 exports the combined program context. Returns HTTP200 with queued status, not CSV content. Follow export_id through the export status workflow; the returned status_url is a versionless relative API path. Worker failures/delivery are reported asynchronously. Requires permission: one of programs_view, manage_programs, program-all. operationId: adminEntityExportEntities parameters: - name: program_id in: path description: >- Accessible program id or all programs. Footer/export also accept0 for the combined context. required: true schema: oneOf: - type: integer example: 42 - type: string enum: - all example: all example: all requestBody: description: Validated request fields for this operation. required: false content: application/json: schema: description: >- Recipient worksheet state. filter is always required, including legacy requests. A supplied filterGroups array must be nonempty. Presence operators isUnknown, hasAnyValue and isEmpty omit value; other groups require it. properties: filter: description: >- Archived-view selector. Use string false for active and true for archived. Recipient views also support available, sponsored and unsponsored. type: string example: 'false' filterGroups: description: >- Multiple typed comparisons. Requires filter when present; value is required except supported presence/empty operators. Saved-view filters are sanitized to current allowed fields. type: array items: $ref: '#/components/schemas/AdminWorksheetFilterGroup' query: description: >- Worksheet search text; recipient search defaults to title/id fields when keysArray is absent. type: string example: Jane keysArray: description: Legacy comparison/search field keys. type: array items: type: string example: display_name comparisonOperator: description: Legacy single comparison operator. type: string example: contains savedFilterId: description: >- Saved view/report from this organization and worksheet module; missing/unmatched ids are ignored. type: integer example: 42 saved_filter_id: description: Compatibility alias for savedFilterId. type: integer example: 42 fields: description: >- Selected column keys; defaults to saved/current form preferences. type: array items: type: string example: display_name column_order: description: Preferred allowed column ordering. type: array items: type: string example: display_name sortKey: description: Allowed selected/system/custom sort key. type: string example: display_name sortOrder: description: >- Sort direction; unsupported directions normalize to asc where validated. type: string enum: - asc - desc example: asc date_from: description: >- Lower date bound, interpreted with module/saved report date semantics. type: string format: date example: '2026-01-01' date_to: description: >- Upper date bound; donor created-at range applies when both bounds are supplied and no advanced date override exists. type: string format: date example: '2026-10-20' program_surface: description: >- Combined all-program scope; defaults recipients. Campaigns selects campaign programs. type: string enum: - recipients - campaigns example: recipients export_delivery: description: >- Use email to request email delivery; omitted/default uses Activity notification/download. Delivery also depends on worker and organization settings. type: string enum: - email example: email column_labels: description: Optional field-key to CSV header-label override map. type: object additionalProperties: type: string example: Recipient name type: object responses: '200': description: Operation result. content: application/json: schema: required: - message - status - export_id - status_url properties: message: type: string example: >- Export initiated successfully. You will get a notification in Activity when the CSV is ready to download. status: type: string enum: - queued example: queued export_id: type: integer example: 42 status_url: type: string example: /admin/entities/exports/42/status 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: Selected organization program is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '500': description: Export initiation failed; message-only JSON body. security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: AdminWorksheetFilterGroup: required: - field - operator properties: field: description: >- System or tenant form field key allowed in the current module/program. type: string example: display_name operator: description: >- Field-compatible comparison, for example equals, notEquals, contains, startsWith, isUnknown, hasAnyValue, isEmpty, greater_than or less_than. Date/age/relationship fields use their field-specific supported operators. type: string example: contains value: description: >- Comparison value. Required except presence/empty operators; scalar, list or field-specific structured date/relationship value. logicalOperator: description: >- Join this valid group to the following group; defaults to AND. Additional field metadata may be passed for typed date and custom-field comparisons. type: string enum: - AND - OR example: AND type: object additionalProperties: {} 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 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.