> ## 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 giving-anniversary opportunity

> Reads one permitted work item with refreshed action-contact readiness, source giving information and reverse-chronological lifecycle events. Requires permission: one of donors_view.



## OpenAPI

````yaml get /admin/giving-anniversaries/opportunities/{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/giving-anniversaries/opportunities/{id}:
    get:
      tags:
        - Fundraising
      summary: Read a giving-anniversary opportunity
      description: >-
        Reads one permitted work item with refreshed action-contact readiness,
        source giving information and reverse-chronological lifecycle events.
        Requires permission: one of donors_view.
      operationId: givingAnniversaryShow
      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:
                  status:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/GivingAnniversaryOpportunity'
                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 donor or anniversary work item is unavailable in this
            organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    GivingAnniversaryOpportunity:
      description: >-
        Anniversary work item, relationship subject, source evidence and current
        outreach readiness. The events field appears only on the detailed show
        endpoint.
      properties:
        id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        client_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        donor_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        household_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        subject_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        action_contact_donor_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        source_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        owner_user_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        acted_by_user_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        dismissed_by_user_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        subject_name:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        action_contact_name:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        donor_name:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        donor_email:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        work_item_type:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        milestone_label:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        source_type:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        source_currency:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        source_designation:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        source_program:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        last_action_note:
          description: Workflow value.
          type: string
          example: Example
          nullable: true
        subject_type:
          type: string
          enum:
            - donor
            - household
            - relationship_group
          example: donor
        milestone_type:
          type: string
          enum:
            - first_gift
            - first_one_time_gift
            - first_recurring_gift
            - first_sponsorship
          example: first_gift
        status:
          type: string
          enum:
            - upcoming
            - due
            - acted
            - snoozed
            - dismissed
            - missed
          example: due
        source_date:
          description: Calendar date in the configured anniversary timezone.
          type: string
          format: date
          example: '2026-10-20'
          nullable: true
        anniversary_date:
          description: Calendar date in the configured anniversary timezone.
          type: string
          format: date
          example: '2026-10-20'
          nullable: true
        last_attributed_gift_date:
          description: Calendar date in the configured anniversary timezone.
          type: string
          format: date
          example: '2026-10-20'
          nullable: true
        anniversary_year:
          description: Anniversary year or years since the source/current attributed gift.
          type: integer
          example: 3
          nullable: true
        years_giving:
          description: Anniversary year or years since the source/current attributed gift.
          type: integer
          example: 3
          nullable: true
        giving_gap_years:
          description: Anniversary year or years since the source/current attributed gift.
          type: integer
          example: 3
          nullable: true
        source_amount:
          description: Attributed amount of the source gift.
          type: number
          example: 25
          nullable: true
        source_snapshot:
          description: Evidence or context whose keys depend on the milestone.
          type: object
          additionalProperties: {}
        evidence:
          description: Evidence or context whose keys depend on the milestone.
          type: object
          additionalProperties: {}
        readiness:
          $ref: '#/components/schemas/GivingAnniversaryReadiness'
        suggested_actions:
          type: array
          items:
            $ref: '#/components/schemas/GivingAnniversarySuggestedAction'
        lifecycle:
          type: array
          items:
            $ref: '#/components/schemas/GivingAnniversaryLifecycleEvent'
        detected_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        acted_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        snoozed_until:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        dismissed_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        events:
          description: Detailed show response only; newest lifecycle event first.
          type: array
          items:
            $ref: '#/components/schemas/GivingAnniversaryLifecycleEvent'
      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
    GivingAnniversaryReadiness:
      description: >-
        Channel readiness respects the current action contact and communication
        preferences. Readiness does not send a message.
      properties:
        contact_required:
          description: Boolean state.
          type: boolean
          example: true
        email_ready:
          description: Boolean state.
          type: boolean
          example: true
        sms_ready:
          description: Boolean state.
          type: boolean
          example: true
        mailing_ready:
          description: Boolean state.
          type: boolean
          example: true
        calendar_ready:
          description: Boolean state.
          type: boolean
          example: true
        do_not_email:
          description: Boolean state.
          type: boolean
          example: true
        email:
          description: Usable action-contact email.
          type: string
          example: Example
          nullable: true
        phone:
          description: Usable action-contact phone.
          type: string
          example: Example
          nullable: true
        reasons:
          type: array
          items:
            type: string
            example: Missing complete mailing address
      type: object
    GivingAnniversarySuggestedAction:
      properties:
        key:
          description: Action key.
          type: string
          example: Example
          nullable: false
        label:
          description: User-facing action name.
          type: string
          example: Example
          nullable: false
        enabled:
          description: Boolean state.
          type: boolean
          example: true
        disabled_reason:
          description: Reason the action is unavailable.
          type: string
          example: Example
          nullable: true
      type: object
    GivingAnniversaryLifecycleEvent:
      properties:
        event_type:
          description: Acted, snoozed, dismissed, reopened or assigned lifecycle event.
          type: string
          example: Example
          nullable: false
        user_id:
          description: Identifier within the current organization.
          type: integer
          example: 42
          nullable: true
        payload:
          description: Action metadata supplied by staff.
          type: object
          additionalProperties: {}
        created_at:
          description: Timestamp.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          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.