On this page
Reports API — read-only
Use the reports API only to retrieve authorized published report metadata and approved report files. Access is optional, tenant-scoped, and disabled unless provisioned by Clearline.
Endpoint names below are customer-facing placeholders until Clearline confirms the exact implementation for your tenant.
List published reports#
GET /api/v1/reports?published_since=2026-06-01T00:00:00Z&page=1&page_size=50 HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer EXAMPLE_READ_ONLY_TOKEN
Accept: application/json
Use this request to list published reports visible to the provisioned scope.
Typical response fields may include:
| Field | Meaning |
|---|---|
report_id | Clearline-provided report identifier. |
report_type | Report or deliverable type, such as COA where enabled. |
sample_ids | Related sample identifiers exposed to the authorized scope. |
published_at | Published timestamp. |
status | Published or otherwise approved customer-facing status. |
download_available | Whether a file download is available for the authorized token. |
Retrieve report metadata#
GET /api/v1/reports/REPORT-EXAMPLE-001 HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer EXAMPLE_READ_ONLY_TOKEN
Accept: application/json
Use this request to retrieve metadata for one authorized published report.
Download an authorized report file#
GET /api/v1/reports/REPORT-EXAMPLE-001/file HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer EXAMPLE_READ_ONLY_TOKEN
Accept: application/pdf
File download access is limited to published files authorized for the provisioned scope. Clearline Support confirms file availability, retention behavior, and any tenant-specific delivery limits during onboarding.
Not supported in read-only access#
The reports API does not publish, retract, amend, regenerate, approve, delete, or change reports. If your workflow requires report generation or publication automation, contact Clearline Support for a scoped implementation review.