> ## 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 Salesforce nonprofit mapping options

> Returns organization donor forms, compatible contribution/number/campaign programs, writable provider fields, object names/labels, approved mappings and interaction availability. Requested choices fall back to stored choices, then only to a sole available option; multiple choices can leave selection null. Provider fields use stored metadata, live describe and built-in fallback in that order. Requires the integration platform global/configured client feature gate (normally integration_platform_foundation). Requires permission: one of access_account_settings.



## OpenAPI

````yaml get /integrations/hub/connections/{connection_id}/salesforce/mapping-options
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:
  /integrations/hub/connections/{connection_id}/salesforce/mapping-options:
    get:
      tags:
        - Integrations
      summary: Read Salesforce nonprofit mapping options
      description: >-
        Returns organization donor forms, compatible
        contribution/number/campaign programs, writable provider fields, object
        names/labels, approved mappings and interaction availability. Requested
        choices fall back to stored choices, then only to a sole available
        option; multiple choices can leave selection null. Provider fields use
        stored metadata, live describe and built-in fallback in that order.
        Requires the integration platform global/configured client feature gate
        (normally integration_platform_foundation). Requires permission: one of
        access_account_settings.
      operationId: integrationSalesforceMappingOptions
      parameters:
        - name: connection_id
          in: path
          description: Connection id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
        - name: hysform_id
          in: query
          description: 'Hysform id. Validation: nullable, integer.'
          required: false
          schema:
            type: integer
            nullable: true
          example: 1
        - name: recipient_program_id
          in: query
          description: 'Recipient program id. Validation: nullable, integer.'
          required: false
          schema:
            type: integer
            nullable: true
          example: 1
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/IntegrationSalesforceMappingOptions'
                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: >-
            Feature, organization-owned connection, selected program or donor
            form is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: >-
            Request, selected provider, field availability or conditional
            mapping settings validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    IntegrationSalesforceMappingOptions:
      description: >-
        Tenant form/program choices, writable provider fields and current
        mapping settings. Field metadata prefers the stored snapshot, then a
        live describe, then built-in fallback. Interaction availability reflects
        provider object create permission.
      properties:
        donor_forms:
          type: array
          items:
            properties:
              id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              name:
                description: Display or configured value.
                type: string
                example: Example
                nullable: false
              type:
                type: string
                enum:
                  - donor
              standardized_fields_enabled:
                type: boolean
                example: true
              standardized_fields_rollout_state:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              do_not_require_email:
                type: boolean
                example: true
            type: object
        selected_hysform_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        hys_fields:
          type: array
          items:
            properties:
              path:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              key:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              label:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              group:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              type:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              permissions:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              required:
                type: boolean
                example: true
              enabled:
                type: boolean
                example: true
            type: object
        salesforce_fields:
          type: array
          items:
            properties:
              name:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              label:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              type:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              custom:
                type: boolean
                example: true
              nillable:
                type: boolean
                example: true
              createable:
                type: boolean
                example: true
              updateable:
                type: boolean
                example: true
              calculated:
                type: boolean
                example: true
              writable:
                type: boolean
                example: true
            type: object
        salesforce_donor_object:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        salesforce_donor_object_label:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        current_mapping:
          oneOf:
            - $ref: '#/components/schemas/IntegrationSalesforceMapping'
            - type: string
              enum:
                - null
              nullable: true
        recipient_program_options:
          type: array
          items:
            properties:
              id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              name:
                description: Display or configured value.
                type: string
                example: Example
                nullable: false
              type:
                type: string
                enum:
                  - contribution
                  - number
                  - campaign
              hysform_id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              recipient_fields:
                type: array
                items:
                  properties:
                    path:
                      description: Display or configured value.
                      type: string
                      example: Example
                      nullable: true
                    key:
                      description: Display or configured value.
                      type: string
                      example: Example
                      nullable: true
                    label:
                      description: Display or configured value.
                      type: string
                      example: Example
                      nullable: true
                    group:
                      description: Display or configured value.
                      type: string
                      example: Example
                      nullable: true
                    type:
                      description: Display or configured value.
                      type: string
                      example: Example
                      nullable: true
                    permissions:
                      description: Display or configured value.
                      type: string
                      example: Example
                      nullable: true
                    required:
                      type: boolean
                      example: true
                    enabled:
                      type: boolean
                      example: true
                  type: object
            type: object
        selected_recipient_program_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        recipient_fields:
          type: array
          items:
            properties:
              path:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              key:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              label:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              group:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              type:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              permissions:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              required:
                type: boolean
                example: true
              enabled:
                type: boolean
                example: true
            type: object
        salesforce_campaign_fields:
          type: array
          items:
            properties:
              name:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              label:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              type:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              custom:
                type: boolean
                example: true
              nillable:
                type: boolean
                example: true
              createable:
                type: boolean
                example: true
              updateable:
                type: boolean
                example: true
              calculated:
                type: boolean
                example: true
              writable:
                type: boolean
                example: true
            type: object
        salesforce_recipient_object:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        salesforce_recipient_object_label:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        recipient_current_mapping:
          oneOf:
            - $ref: '#/components/schemas/IntegrationSalesforceMapping'
            - type: string
              enum:
                - null
              nullable: true
        recipient_inbound_enabled:
          type: boolean
          example: true
        interaction_sync_enabled:
          type: boolean
          example: true
        interaction_inbound_enabled:
          type: boolean
          example: true
        interaction_objects:
          type: array
          items:
            type: string
            enum:
              - Task
              - Call
              - Event
              - EmailMessage
        interaction_object_options:
          type: array
          items:
            properties:
              value:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              label:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              description:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              salesforce_object:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              disabled_reason:
                description: Display or configured value.
                type: string
                example: Example
                nullable: true
              createable:
                type: boolean
                example: true
              updateable:
                type: boolean
                example: true
              available:
                type: boolean
                example: true
            type: object
        donation_outbound_enabled:
          type: boolean
          example: true
        donation_inbound_enabled:
          type: boolean
          example: true
        salesforce_donation_object:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        salesforce_donation_object_label:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        donation_current_mapping:
          oneOf:
            - $ref: '#/components/schemas/IntegrationSalesforceMapping'
            - type: string
              enum:
                - null
              nullable: true
        metadata_snapshot_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          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
    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
    IntegrationSalesforceMapping:
      description: >-
        Stored mapping version returned by the Salesforce controller, with
        provider-specific field ownership and required-object metadata.
      properties:
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        connection_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        provider_key:
          type: string
          enum:
            - salesforce_npsp
            - salesforce_nonprofit_cloud
        hys_object_type:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        provider_object_type:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        mapping_version:
          description: Count.
          type: integer
          minimum: 0
          example: 2
        status:
          description: Display or configured value.
          type: string
          example: Example
          nullable: false
        source_of_truth_json:
          description: Stored provider/workflow JSON.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        mapping_json:
          description: Stored provider/workflow JSON.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        defaults_json:
          description: Stored provider/workflow JSON.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        metadata_json:
          description: Stored provider/workflow JSON.
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
        approved_at:
          description: Timestamp.
          type: string
          format: date-time
          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.