Samples API — read-only
Use the samples API only to retrieve authorized sample records and status information. 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 samples#
GET /api/v1/samples?status=received&updated_since=2026-06-01T00:00:00Z&page=1&page_size=50 HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer <clearline-readonly-token>
Accept: application/json
Use this request to list samples visible to the provisioned scope.
Typical response fields may include:
| Field | Meaning |
|---|---|
sample_id | Clearline-provided sample identifier or tenant-facing sample key. |
client_sample_id | Submitter or client-provided sample identifier, where available. |
status | Current sample status exposed for read-only integration use. |
received_at | Sample received timestamp, where available. |
updated_at | Last exposed status or metadata update timestamp. |
project_id | Approved project or work-order reference, where available. |
Retrieve one sample#
GET /api/v1/samples/SAMPLE-EXAMPLE-001 HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer <clearline-readonly-token>
Accept: application/json
Use this request to retrieve details for one authorized sample. The response may include sample metadata, current status, requested analyses, collection information, and reporting status if enabled for your tenant.
Filters#
Supported filters are confirmed during onboarding. Common read-only filters may include:
status;updated_since;received_since;project_id;client_sample_id;pageandpage_size.
Not supported in read-only access#
The samples API does not create samples, receive samples, enter results, import results, change workflow state, amend records, delete records, or administer setup data. If your integration needs one of those actions, contact Clearline Support for a scoped implementation review.