> ## 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. # Preview stewardship relationship provisioning > Requires stewardship_relationship_groups_v1 and unrestricted donor-form visibility. Reads enabled reciprocal relationship mappings and soft-credit evidence, returning available/blocked/review candidates with a policy/evidence fingerprint. Does not create groups. Requires permission: one of donors_view. ## OpenAPI ````yaml get /admin/fundraising/relationship-provisioning/preview 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/fundraising/relationship-provisioning/preview: get: tags: - Fundraising summary: Preview stewardship relationship provisioning description: >- Requires stewardship_relationship_groups_v1 and unrestricted donor-form visibility. Reads enabled reciprocal relationship mappings and soft-credit evidence, returning available/blocked/review candidates with a policy/evidence fingerprint. Does not create groups. Requires permission: one of donors_view. operationId: fundraisingHubRelationshipProvisioningPreview responses: '200': description: Operation result. content: application/json: schema: properties: status: type: string example: success data: $ref: '#/components/schemas/FundraisingHubProvisioningPreview' 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 selected organization record or required feature is unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: FundraisingHubProvisioningPreview: properties: enabled: description: Workflow state. type: boolean example: true policy_version: description: Count. type: integer example: 2 nullable: false default_giving_scope: description: Serialized value. type: string example: Example nullable: true fingerprint: description: >- SHA-256 of policy, candidates and evidence; return unchanged when applying. type: string maxLength: 64 minLength: 64 example: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa summary: properties: total: description: Count. type: integer example: 2 nullable: false returned: description: Count. type: integer example: 2 nullable: false selected: description: Count. type: integer example: 2 nullable: false review: description: Count. type: integer example: 2 nullable: false needs_mapping: description: Count. type: integer example: 2 nullable: false blocked: description: Count. type: integer example: 2 nullable: false already_active: description: Count. type: integer example: 2 nullable: false deactivated: description: Count. type: integer example: 2 nullable: false type: object candidates: type: array items: $ref: '#/components/schemas/FundraisingHubProvisioningCandidate' truncated: description: Workflow state. type: boolean example: true selection_limited: description: Workflow state. type: boolean example: true selection_limit: description: Count. type: integer example: 2 nullable: false 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 FundraisingHubProvisioningCandidate: properties: candidate_key: description: Serialized value. type: string example: Example nullable: false status: type: string enum: - available - already_active - deactivated - blocked - needs_mapping example: available confidence: type: string enum: - high - review example: high recommended_action: type: string enum: - create - review - add_mapping - none example: create selected_by_default: description: Workflow state. type: boolean example: true blockers: type: array items: type: string core: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false name: description: Serialized value. type: string example: Example nullable: true subject_type: type: string enum: - donor - household example: donor type: object additionalProperties: {} mapped_vehicles: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true rule_keys: type: array items: type: string relationship_evidence: type: array items: properties: forward_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false reverse_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false core_relationship_type: description: Serialized value. type: string example: Example nullable: true vehicle_relationship_type: description: Serialized value. type: string example: Example nullable: true type: object soft_credit: description: Stored context; keys depend on the source. oneOf: - type: object additionalProperties: {} - type: array items: {} giving_scope: description: Serialized value. type: string example: Example nullable: true type: object additionalProperties: {} evidence_only_vehicles: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true rule_keys: type: array items: type: string relationship_evidence: type: array items: properties: forward_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false reverse_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false core_relationship_type: description: Serialized value. type: string example: Example nullable: true vehicle_relationship_type: description: Serialized value. type: string example: Example nullable: true type: object soft_credit: description: Stored context; keys depend on the source. oneOf: - type: object additionalProperties: {} - type: array items: {} giving_scope: description: Serialized value. type: string example: Example nullable: true type: object additionalProperties: {} mapped_vehicle_count: description: Count. type: integer example: 2 nullable: false evidence_only_vehicle_count: description: Count. type: integer example: 2 nullable: false giving_scope: description: Serialized value. type: string example: Example nullable: true evidence: properties: rule_keys: type: array items: type: string relationship_evidence: type: array items: type: object additionalProperties: {} soft_credit: properties: gift_count: description: Count. type: integer example: 2 nullable: false attributed_amount: description: Amount or percentage. type: number example: 25 nullable: false soft_credit_type_keys: type: array items: type: string policy_basis: type: array items: type: string type: object type: object proposed_group: properties: kind: description: Serialized value. type: string example: Example nullable: true display_name: description: Serialized value. type: string example: Example nullable: true core_subject_type: description: Serialized value. type: string example: Example nullable: true core_subject_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false assigned_fundraiser_user_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true links: type: array items: properties: id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false household_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: true name: description: Serialized value. type: string example: Example nullable: false email: description: Serialized value. type: string example: Example nullable: true is_organization: description: Workflow state. type: boolean example: true is_archived: description: Workflow state. type: boolean example: true link_id: description: Identifier in the authenticated organization. type: integer example: 42 nullable: false role: type: string enum: - giving_vehicle - relationship_lead - designated_contact - affiliated_contact example: giving_vehicle giving_scope: type: string enum: - none - attributed_only - all_qualified example: attributed_only expects_attribution: description: Workflow state. type: boolean example: true is_primary_contact: description: Workflow state. type: boolean example: true collapse_in_portfolio: description: Workflow state. type: boolean example: true relationship_label: description: Serialized value. type: string example: Example nullable: true legal_lifetime_giving: description: Amount or percentage. type: number example: 25 nullable: false legal_ytd_giving: description: Amount or percentage. type: number example: 25 nullable: false legal_gift_count: description: Count. type: integer example: 2 nullable: false type: object type: object 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.