---
title: "The handout library (ITE-1477): every handout with its current version and how often it was sent, opened and acknowledged."
method: GET
path: "/Questionnaires/handouts/library"
tags: ["Questionnaires"]
---

# The handout library (ITE-1477): every handout with its current version and how often it was sent, opened and acknowledged.

`GET /Questionnaires/handouts/library`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/Questionnaires/handouts/library`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/Questionnaires/handouts/library/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

OK

- HandoutLibraryItemDto[]
  - `questionnaireId` string
  - `name` string
  - `status` integer
  - `contentMode` integer: Where a handout's content comes from (ITE-1473). Stored as text in `questionnaires.handout_content_mode`; null on every non-handout questionnaire.
  - `acknowledgement` integer: What a client must do with a handout (ITE-1473). Stored as text in `questionnaires.handout_acknowledgement`; null on every non-handout questionnaire. The answer fields each value requires come from `QuestionnaireTypeAffordances.HandoutAcknowledgementFieldIds`.
  - `currentVersion` HandoutVersionSummaryDto: The headline facts of one handout version (ITE-1474).
    - `version` union
      - integer
      - string, int32
    - `contentMode` integer: Where a handout's content comes from (ITE-1473). Stored as text in `questionnaires.handout_content_mode`; null on every non-handout questionnaire.
    - `fileName` string, nullable
    - `createdAt` string, date-time
  - `updatedAt` string, date-time: The later of the handout's own edit and its current version.
  - `timesSent` union: Responses that went out with a link (email, SMS or in clinic).
    - integer
    - string, int32
  - `openedCount` union: Of those, the ones the client opened (an acknowledged one was opened too).
    - integer
    - string, int32
  - `acknowledgedCount` union: Of those, the ones the client acknowledged. Always 0 for a read-only handout.
    - integer
    - string, int32
  - `lastSentAt` string, date-time, nullable
  - `automationCount` union: Automation rules that send it; the library warns before archiving one in use.
    - integer
    - string, int32
  - `reviewIntervalMonths` union: "Review every N months" (ITE-1481); null without a review schedule.
    - integer
    - string, int32
  - `reviewDueAt` string, date-time, nullable: When the next review falls due; null without a review schedule.
  - `reviewDue` boolean: A published handout whose review is due: the library's "Review due" badge.
  - `lastReviewedAt` string, date-time, nullable
  - `reviewOwnerName` string, nullable: Who is reminded: the owner's name, or the role's.

## Changes

- **2026-10-28** `099cf36186e0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/Questionnaires/handouts/library/get.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)