Request
GET https://api.clinikapi.com/v1/documents
Headers
Your ClinikAPI secret key (
clk_live_* or clk_test_*).Query parameters
Filter documents to a specific patient (e.g.
pt_abc123).Filter by the practitioner who authored the document (e.g.
prac_def456).Filter by document type (e.g.
discharge-summary, referral-letter, care-plan).Filter by document status. One of:
preliminary, final, amended.Return documents with a date on or after this value. Format:
YYYY-MM-DD.Return documents with a date on or before this value. Format:
YYYY-MM-DD.Sort order. Prefix with
- for descending. Example: -date returns the most recent documents first.Page number for paginated results. Defaults to
1.Number of results per page. Defaults to
20. Maximum 100.Response
Returns200 OK with an array of documents and pagination metadata.
Array of document objects matching the query. Each item contains the same fields as the single-document read endpoint.
Total number of documents matching the query across all pages.
Current page number.
Number of results per page.
Standard response metadata including
requestId, timestamp, status, and rate-limit fields.