API Reference
  1. Viv Public API
  2. Caregivers

List caregiver documents (metadata only)

get
https://{apiHost}/api/v2/public/caregivers//documents

Retrieve document metadata for all documents associated with a caregiver.

IMPORTANT: This endpoint returns document METADATA only.

  • ✓ Document name, type, status, expiry date
  • ✓ Upload/modification dates and user info
  • ❌ Does NOT return file content
  • ❌ Does NOT return S3 URLs or download links
  • ❌ File download capability not currently available via public API

Use this endpoint to:

  • List what documents exist for a caregiver
  • Check document status and expiry dates
  • Verify required documents are uploaded
  • Track document metadata changes
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique caregiver identifier

Query Params
integer
1 to 100
Defaults to 20

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

string

Filter by document type label. The type is a free-form,
tenant-configured string — match it exactly against the labels
configured by the customer's org admin.

string

Filter by document status. Status is a free-form string, not an
enum, and is matched exactly. Newly created documents default to
"Uploaded" (controller behavior), so a filter like
status=active will return nothing unless that label has been
applied explicitly.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?