> ## 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 communication coverage target history

> Finds a permitted target across all target types/statuses while respecting program/source/channel context. Returns its projection, current queue summary and one newest-first timeline page; there is no timeline total/page metadata. A full timeline event can be context-only, so check qualifies_for_target. Requires communications_coverage enabled (or the configured explicit environment opt-in), an active non-disabled user and communications_coverage_view. Program and donor-form access restrict every surface; mailbox quick links additionally require email_manager/manage_email. Requires permission: one of communications_coverage_view.



## OpenAPI

````yaml get /admin/communications/coverage/targets/{coverageTargetId}
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/communications/coverage/targets/{coverageTargetId}:
    get:
      tags:
        - Communications
      summary: Read communication coverage target history
      description: >-
        Finds a permitted target across all target types/statuses while
        respecting program/source/channel context. Returns its projection,
        current queue summary and one newest-first timeline page; there is no
        timeline total/page metadata. A full timeline event can be context-only,
        so check qualifies_for_target. Requires communications_coverage enabled
        (or the configured explicit environment opt-in), an active non-disabled
        user and communications_coverage_view. Program and donor-form access
        restrict every surface; mailbox quick links additionally require
        email_manager/manage_email. Requires permission: one of
        communications_coverage_view.
      operationId: communicationsCoverageShowTarget
      parameters:
        - name: coverageTargetId
          in: path
          description: Coveragetarget id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
        - name: target_type
          in: query
          description: >-
            Target type. Validation: sometimes, string; allowed values:
            sponsorship_pair, donor, donor_program, all.
          required: false
          schema:
            type: string
            enum:
              - sponsorship_pair
              - donor
              - donor_program
              - all
          example: sponsorship_pair
        - name: rollup_type
          in: query
          description: >-
            Rollup type. Validation: sometimes, string; allowed values:
            recipient, program.
          required: false
          schema:
            type: string
            enum:
              - recipient
              - program
          example: recipient
        - name: source_types
          in: query
          description: >-
            Source types. Validation: sometimes, array. Arrays also accept
            comma-separated strings.
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              description: >-
                Source types item. Validation: string; allowed values:
                message_manager, recipient_portal, mailing, newsletter,
                system_email.
              type: string
              enum:
                - message_manager
                - recipient_portal
                - mailing
                - newsletter
                - system_email
              example: message_manager
          example:
            - message_manager
        - name: program_ids
          in: query
          description: >-
            Program ids. Validation: sometimes, array. Arrays also accept
            comma-separated strings.
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              description: 'Program ids item. Validation: integer, min:1.'
              type: integer
              minimum: 1
              example: 1
          example:
            - 1
        - name: target_statuses
          in: query
          description: >-
            Target statuses. Validation: sometimes, array. Arrays also accept
            comma-separated strings.
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              description: >-
                Target statuses item. Validation: string; allowed values:
                active, due, inactive, archived.
              type: string
              enum:
                - active
                - due
                - inactive
                - archived
              example: active
          example:
            - active
        - name: coverage_statuses
          in: query
          description: >-
            Coverage statuses. Validation: sometimes, array. Arrays also accept
            comma-separated strings.
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              description: >-
                Coverage statuses item. Validation: string; allowed values:
                welcome_gap, never_covered, only_context, stale_30, stale_60,
                stale_90, covered.
              type: string
              enum:
                - welcome_gap
                - never_covered
                - only_context
                - stale_30
                - stale_60
                - stale_90
                - covered
              example: welcome_gap
          example:
            - welcome_gap
        - name: stale_days
          in: query
          description: >-
            Stale days. Validation: sometimes, integer; allowed values: 30, 60,
            90.
          required: false
          schema:
            type: integer
            enum:
              - 30
              - 60
              - 90
          example: 30
        - name: channels
          in: query
          description: >-
            Channels. Validation: sometimes, array. Arrays also accept
            comma-separated strings.
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              description: >-
                Channels item. Validation: string; allowed values: email, print,
                sms, note.
              type: string
              enum:
                - email
                - print
                - sms
                - note
              example: email
          example:
            - email
        - name: metric_mode
          in: query
          description: >-
            Accepted compatibility choice; this implementation computes
            written_coverage in either mode.
          required: false
          schema:
            type: string
            enum:
              - written_coverage
              - touchpoints_context
          example: written_coverage
        - name: active_donor_window_days
          in: query
          description: >-
            Donation-based eligibility window, default730days; affects donor and
            donor_program audience periods.
          required: false
          schema:
            type: integer
            maximum: 3650
            minimum: 1
          example: 1
        - name: household_mode
          in: query
          description: >-
            Accepted compatibility choice; this implementation continues to
            project person-level targets.
          required: false
          schema:
            type: string
            enum:
              - person
              - household
          example: person
        - name: assigned_admin_id
          in: query
          description: 'Assigned admin id. Validation: nullable, integer, min:1.'
          required: false
          schema:
            type: integer
            minimum: 1
            nullable: true
          example: 1
        - name: include_transactional_context
          in: query
          description: 'Include transactional context. Validation: sometimes, boolean.'
          required: false
          schema:
            type: boolean
          example: true
        - name: include_broadcast_context
          in: query
          description: 'Include broadcast context. Validation: sometimes, boolean.'
          required: false
          schema:
            type: boolean
          example: true
        - name: include_covered
          in: query
          description: 'Include covered. Validation: sometimes, boolean.'
          required: false
          schema:
            type: boolean
          example: true
        - name: unread_only
          in: query
          description: 'Unread only. Validation: sometimes, boolean.'
          required: false
          schema:
            type: boolean
          example: true
        - name: pending_approval_only
          in: query
          description: 'Pending approval only. Validation: sometimes, boolean.'
          required: false
          schema:
            type: boolean
          example: true
        - name: no_thread_only
          in: query
          description: 'No thread only. Validation: sometimes, boolean.'
          required: false
          schema:
            type: boolean
          example: true
        - name: page
          in: query
          description: 'Page. Validation: sometimes, integer, min:1.'
          required: false
          schema:
            type: integer
            minimum: 1
          example: 1
        - name: per_page
          in: query
          description: 'Per page. Validation: sometimes, integer, min:1, max:100.'
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
          example: 1
        - name: sort
          in: query
          description: 'Sort. Validation: sometimes, array.'
          required: false
          style: deepObject
          explode: true
          schema:
            properties:
              field:
                description: >-
                  Sort / field. Validation: sometimes, string; allowed values:
                  severity, coverage_status, target_started_at,
                  last_qualifying_touch_at, last_context_only_touch_at,
                  coverage_rate_30d, active_target_count,
                  never_covered_target_count, only_context_target_count,
                  stale_target_count_60d, pending_approval_count,
                  unread_inbound_count.
                type: string
                enum:
                  - severity
                  - coverage_status
                  - target_started_at
                  - last_qualifying_touch_at
                  - last_context_only_touch_at
                  - coverage_rate_30d
                  - active_target_count
                  - never_covered_target_count
                  - only_context_target_count
                  - stale_target_count_60d
                  - pending_approval_count
                  - unread_inbound_count
                example: severity
              direction:
                description: >-
                  Sort / direction. Validation: sometimes, string; allowed
                  values: asc, desc.
                type: string
                enum:
                  - asc
                  - desc
                example: asc
            type: object
          example:
            field: severity
            direction: asc
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      target:
                        $ref: '#/components/schemas/CommunicationsCoverageTarget'
                      timeline:
                        type: array
                        items:
                          $ref: >-
                            #/components/schemas/CommunicationsCoverageTimelineEvent
                      queue_state:
                        properties:
                          latest_thread_id:
                            description: Organization-owned record identifier.
                            type: integer
                            example: 42
                            nullable: true
                          latest_thread_status:
                            description: Currently null in this coverage projection.
                            type: string
                            nullable: true
                          assigned_admin_id:
                            description: Organization-owned record identifier.
                            type: integer
                            example: 42
                            nullable: true
                          assigned_admin_name:
                            type: string
                            example: Example
                            nullable: true
                          unread_inbound_count:
                            type: integer
                            example: 1
                          pending_approval_count:
                            type: integer
                            example: 1
                        type: object
                      actions:
                        description: >-
                          Application navigation paths. Mailbox/compose paths
                          are null without current mailbox permission.
                        properties:
                          open_donor_url:
                            type: string
                            example: /app/view_donor/42
                            nullable: true
                          open_recipient_url:
                            type: string
                            example: /app/view_donor/42
                            nullable: true
                          open_message_manager_url:
                            type: string
                            example: /app/view_donor/42
                            nullable: true
                          open_coverage_url:
                            type: string
                            example: /app/view_donor/42
                            nullable: true
                          compose_url:
                            type: string
                            example: /app/view_donor/42
                            nullable: true
                        type: object
                    type: object
                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 coverage feature, target or owned artifact is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CommunicationsCoverageTarget:
      description: >-
        Permitted coverage target and event aggregates, bounded by current
        eligibility period and selected sources/channels. has_thread reflects
        any event, while has_conversation_thread requires a Conversations
        thread.
      properties:
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        client_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        coverage_target_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        donor_entity_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        donor_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        entity_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        program_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        assigned_admin_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        latest_thread_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        target_key:
          type: string
          example: donor:42
        target_type:
          type: string
          enum:
            - sponsorship_pair
            - donor
            - donor_program
          example: sponsorship_pair
        basis_type:
          type: string
          example: commitment
        target_status:
          type: string
          enum:
            - active
            - due
            - inactive
            - archived
          example: active
        coverage_status:
          type: string
          enum:
            - welcome_gap
            - never_covered
            - only_context
            - stale_30
            - stale_60
            - stale_90
            - covered
          example: never_covered
        target_started_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        target_ended_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        created_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        updated_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        last_qualifying_touch_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        last_any_written_touch_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        last_context_only_touch_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        latest_inbound_at:
          description: UTC database timestamp.
          type: string
          example: '2026-10-20 12:00:00'
          nullable: true
        qualifying_count:
          description: >-
            SQL aggregate count; serialized numeric representation follows the
            database driver.
          oneOf:
            - type: integer
              example: 1
            - type: string
              example: '1'
        context_count:
          description: >-
            SQL aggregate count; serialized numeric representation follows the
            database driver.
          oneOf:
            - type: integer
              example: 1
            - type: string
              example: '1'
        event_count:
          description: >-
            SQL aggregate count; serialized numeric representation follows the
            database driver.
          oneOf:
            - type: integer
              example: 1
            - type: string
              example: '1'
        pending_approval_count:
          type: integer
          example: 1
        unread_inbound_count:
          type: integer
          example: 1
        covered_30d:
          type: integer
          example: 1
        severity:
          type: integer
          example: 1
        quick_links:
          description: >-
            Application navigation paths. Mailbox/compose paths are null without
            current mailbox permission.
          properties:
            open_donor_url:
              type: string
              example: /app/view_donor/42
              nullable: true
            open_recipient_url:
              type: string
              example: /app/view_donor/42
              nullable: true
            open_message_manager_url:
              type: string
              example: /app/view_donor/42
              nullable: true
            open_coverage_url:
              type: string
              example: /app/view_donor/42
              nullable: true
            compose_url:
              type: string
              example: /app/view_donor/42
              nullable: true
          type: object
        has_thread:
          type: boolean
          example: true
        has_conversation_thread:
          type: boolean
          example: true
        latest_inbound_unread:
          type: boolean
          example: true
        latest_thread_status:
          description: Currently null in this coverage projection.
          type: string
          nullable: true
        assigned_admin_name:
          type: string
          example: Example
          nullable: true
        donor_name:
          type: string
          example: Example
          nullable: true
        entity_name:
          type: string
          example: Example
          nullable: true
        program_name:
          type: string
          example: Example
          nullable: true
        programs_summary:
          type: string
          example: Example
          nullable: false
        timeline:
          type: array
          items: {}
          maxItems: 0
      type: object
    CommunicationsCoverageTimelineEvent:
      properties:
        event_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        source_type:
          type: string
          enum:
            - message_manager
            - recipient_portal
            - mailing
            - newsletter
            - system_email
          example: message_manager
        channel:
          type: string
          enum:
            - email
            - print
            - sms
            - note
          example: email
        coverage_scope:
          type: string
          example: recipient_specific
        direction:
          type: string
          example: outbound
        delivery_status:
          type: string
          example: sent
        qualifies_for_target:
          type: boolean
          example: true
        label:
          type: string
          example: Education update
      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
    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.