List Documents¶

Retrieve a paginated list of documents for a patient. Supports filtering by category, type, signature status, case, and date range.

Endpoint¶

GET /apis/v1/patient-document/{patientId}

Path Parameters¶

Parameter	Type	Required	Description
`patientId`	integer	Yes	The patient's ID

Query Parameters¶

Parameter	Type	Required	Description
`document_category`	string	No	Filter by category (repeatable); values: `INSURANCE_CARD`, `MEDICAL_HISTORY`, etc. (see Category Values)
`document_type`	string	No	Filter by free-text document type label (repeatable)
`signed`	string	No	Filter by signature status (repeatable); values: `COMPLETED`, `INCOMPLETED`, `COSIGN`, `REVISION`
`document_name`	string	No	Filter by document name (partial match)
`case_title`	string	No	Filter by `spry_case_id` (repeatable)
`page`	integer	No	Page number, 1-based (default: `1`)
`size`	integer	No	Records per page (default: `5`)
`sort`	string	No	Sort direction: `asc` or `desc` (default: `desc`)
`sort_by`	string	No	Field to sort by (default: `createdAt`)
`start`	string (datetime)	No	Filter documents created on or after this datetime (`YYYY-MM-DDTHH:mm:ss`)
`end`	string (datetime)	No	Filter documents created on or before this datetime (`YYYY-MM-DDTHH:mm:ss`)

Request¶

curl --location '{base_url}/apis/v1/patient-document/1172416?page=1&size=10&sort=desc' \
  --header 'Authorization: Bearer JWT_TOKEN'

Request Examples¶

Filter by Category¶

curl --location '{base_url}/apis/v1/patient-document/1172416?document_category=INSURANCE_CARD&document_category=INSURANCE' \
  --header 'Authorization: Bearer JWT_TOKEN'

Filter by Case and Date Range¶

curl --location '{base_url}/apis/v1/patient-document/1172416?case_title=SPRY_CASE_69cd0c97e7562d613ea89bc7&start=2026-01-01T00:00:00&end=2026-12-31T23:59:59' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
  "code": 2000,
  "data": {
    "documents": [
      {
        "id": 458312,
        "name": "PEHP Insurance Card",
        "patient_id": 1172416,
        "uploaded_by": 8821,
        "document_url": "https://storage.googleapis.com/us-phy-uploads/patients/1172416/documents/insurance-card.pdf",
        "unsigned_document_url": "https://storage.googleapis.com/us-phy-uploads/patients/1172416/documents/insurance-card.pdf",
        "thumbnail_url": null,
        "bucket_name": "us-phy-uploads",
        "document_type": "Insurance Card",
        "document_category": "INSURANCE_CARD",
        "spry_case_id": "SPRY_CASE_69cd0c97e7562d613ea89bc7",
        "case_title": "Stable Burst Fracture",
        "eligible_visit_count": 0,
        "notes": "Primary insurance card — PEHP plan 2025-2026",
        "document_expiration_date": null,
        "receipt_date": "2026-04-01T09:00:00",
        "signature_status": null,
        "signed_by": null,
        "signed_at": null,
        "original_file_name": "insurance-card.pdf",
        "created_at": "2026-04-01T12:00:00",
        "updated_at": "2026-04-01T12:00:00"
      }
    ]
  },
  "message": "Success"
}

Response Fields¶

Field	Type	Description
`documents`	array	List of document records for the patient

Each document object in the array has the same fields as Save Document.

Error Response¶

Code: 200 OK

{
  "code": 4004,
  "data": null,
  "message": "Patient not found"
}