Skip to main content
GET
Export notes as PDF

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

type
enum<string>
required

Note owner type. The controller accepts donor or entity and uses it to choose the tenant-scoped model lookup.

Available options:
donor,
entity
id
integer<int64>
required

Donor or entity ID whose notes should be exported. The ID is scoped to the authenticated client before PDF generation.

Query Parameters

program_id
required

Program context used to load available categories and label entity-category notes. Validation rule: required.

cat
integer | null

Optional category ID filter. When present, only notes matching this category are included in the PDF.

Response

PDF file containing matching notes.

The response is of type file.