> ## 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 recipient participation timeline

> Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_view, participation_record, participation_submit or participation_configure. Results follow the caller’s site/cohort scope. Requires visible placement or submitted/superseded/voided evidence within the caller’s scope for restricted roles. Includes archived recipients, scoped placement history and finalized evidence; draft observations are omitted. Scoped current state is reconstructed from permitted evidence and conceals program-wide follow-ups; unrestricted callers receive the rollup and any viewable open follow-up.



## OpenAPI

````yaml get /admin/programs/{program_id}/participation/recipients/{entity_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/programs/{program_id}/participation/recipients/{entity_id}:
    get:
      tags:
        - Participation
      summary: Read a recipient participation timeline
      description: >-
        Requires the participation feature, programs_view and access to this
        organization-owned program. Requires participation_view,
        participation_record, participation_submit or participation_configure.
        Results follow the caller’s site/cohort scope. Requires visible
        placement or submitted/superseded/voided evidence within the caller’s
        scope for restricted roles. Includes archived recipients, scoped
        placement history and finalized evidence; draft observations are
        omitted. Scoped current state is reconstructed from permitted evidence
        and conceals program-wide follow-ups; unrestricted callers receive the
        rollup and any viewable open follow-up.
      operationId: docParticipationRecipientTimelineGET
      parameters:
        - name: program_id
          in: path
          description: >-
            Program whose participation setup, placements and checks are being
            accessed.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 123
        - name: entity_id
          in: path
          description: Recipient ID within this program.
          required: true
          schema:
            type: integer
            minimum: 1
          example: 123
      responses:
        '200':
          description: Read a recipient participation timeline response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipationRecipientTimelineReference'
        '401':
          description: Missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The caller lacks the required permission, resource access or feature
            availability.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The organization-owned resource or parent was not found or is not
            available for this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    ParticipationRecipientTimelineReference:
      required:
        - recipient
        - current
        - placements
        - evidence
      properties:
        recipient:
          required:
            - id
            - display_name
            - is_visible
            - is_archived
            - profile_readiness
          properties:
            id:
              type: integer
            display_name:
              type: string
            is_visible:
              type: boolean
            is_archived:
              type: boolean
            profile_readiness:
              $ref: '#/components/schemas/ParticipationProfileReadinessReference'
          type: object
        current:
          required:
            - site
            - cohort
            - enrollment_state
            - last_verified_on
            - last_seen_on
            - evidence_source
            - consecutive_unresolved_checks
            - unresolved_since
            - follow_up
          properties:
            site:
              type: string
              nullable: true
            cohort:
              type: string
              nullable: true
            enrollment_state:
              type: string
              nullable: true
            last_verified_on:
              type: string
              format: date
              nullable: true
            last_seen_on:
              type: string
              format: date
              nullable: true
            evidence_source:
              type: string
              nullable: true
            consecutive_unresolved_checks:
              type: integer
            unresolved_since:
              type: string
              format: date
              nullable: true
            follow_up:
              oneOf:
                - allOf:
                    - $ref: '#/components/schemas/ParticipationFollowUpReference'
                - type: string
                  enum:
                    - null
                  nullable: true
          type: object
          nullable: true
        placements:
          type: array
          items:
            required:
              - id
              - site
              - cohort
              - state
              - started_on
              - ended_on
              - current
              - source
              - recorded_at
              - source_session_id
              - revision
              - reason_code
              - note
              - operator
              - import
            properties:
              id:
                type: integer
              site:
                type: string
                nullable: true
              cohort:
                type: string
                nullable: true
              state:
                type: string
              started_on:
                type: string
                format: date
                nullable: true
              ended_on:
                type: string
                format: date
                nullable: true
              current:
                type: boolean
              source:
                type: string
              recorded_at:
                type: string
                format: date-time
                nullable: true
              source_session_id:
                type: integer
                nullable: true
              revision:
                type: integer
                nullable: true
              reason_code:
                type: string
                nullable: true
              note:
                type: string
                nullable: true
              operator:
                required:
                  - id
                  - name
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                type: object
                nullable: true
              import:
                required:
                  - id
                properties:
                  id:
                    type: integer
                type: object
                nullable: true
            type: object
        evidence:
          type: array
          items:
            required:
              - session_id
              - date
              - session_status
              - session_type
              - revision
              - is_correction
              - recorded_at
              - source
              - site
              - cohort
              - destination_site
              - destination_cohort
              - reason_code
              - note
              - effective_on
              - new_entrant
              - operator
              - import
              - encounter_status
              - enrollment_confirmation
              - evidence_source
            properties:
              session_id:
                type: integer
              date:
                type: string
                format: date
                nullable: true
              session_status:
                type: string
                nullable: true
              session_type:
                type: string
                nullable: true
              revision:
                type: integer
              is_correction:
                type: boolean
              recorded_at:
                type: string
                format: date-time
                nullable: true
              source:
                type: string
              site:
                type: string
                nullable: true
              cohort:
                type: string
                nullable: true
              destination_site:
                type: string
                nullable: true
              destination_cohort:
                type: string
                nullable: true
              reason_code:
                type: string
                nullable: true
              note:
                type: string
                nullable: true
              effective_on:
                type: string
                format: date
                nullable: true
              new_entrant:
                type: boolean
              operator:
                required:
                  - id
                  - name
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                type: object
                nullable: true
              import:
                required:
                  - id
                properties:
                  id:
                    type: integer
                type: object
                nullable: true
              encounter_status:
                type: string
                enum:
                  - seen
                  - not_seen
                  - not_checked
                  - not_expected
                  - unclear
              enrollment_confirmation:
                type: string
                enum:
                  - confirmed_enrolled
                  - transferred
                  - withdrawn
                  - graduated
                  - unresolved
                  - null
                nullable: true
              evidence_source:
                type: string
                enum:
                  - official_record
                  - headcount
                  - staff_confirmation
                  - participant_confirmation
                  - legacy_import
                  - other
                  - null
                nullable: true
            type: object
      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
    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
    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
    ParticipationProfileReadinessReference:
      required:
        - ready
        - status
        - missing_keys
        - missing_labels
      properties:
        ready:
          type: boolean
        status:
          type: string
          enum:
            - ready
            - incomplete
        missing_keys:
          type: array
          items:
            type: string
        missing_labels:
          type: array
          items:
            type: string
      type: object
    ParticipationFollowUpReference:
      required:
        - id
        - title
        - status
        - due_date
      properties:
        id:
          type: integer
        title:
          type: string
        status:
          type: string
        due_date:
          type: string
          format: date
          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.