On this page

Read-only API access

Clearline LIMS API access is optional, tenant-scoped, and disabled unless Clearline provisions it for your organization. This page defines the customer-facing boundary for read-only access; it is not an implementation contract until Clearline confirms the exact endpoints, scopes, and onboarding steps for your tenant.

Read-only boundary#

Customer API access is for retrieving records and published deliverables within an approved provisioned scope. It is not for creating work, entering results, changing workflow state, administering users, or modifying setup data.

Allowed patterns are limited to read, list, query, and approved file download operations. If your team needs automation that changes lab records, open a Clearline Support ticket so the workflow, validation risk, audit trail, and responsibility boundaries can be reviewed before any integration is designed.

Access model#

Clearline provisions API credentials only after confirming the tenant, user or service-account owner, intended integration, and minimum access scope required.

Typical controls include:

tenant-scoped credentials issued by Clearline;
access limited to an approved client, lab, or role scope;
token rotation and revocation through Clearline Support;
audit logging for API usage where enabled;
onboarding guidance for rate limits, filters, and support escalation.

Do not share API credentials in email, tickets, screenshots, source control, spreadsheets, or chat transcripts. If a credential may have been exposed, contact Clearline Support and request rotation.

Candidate read-only data areas#

The following areas are candidates for read-only customer API documentation after implementation verification:

Area	Intended read-only use
Samples	List provisioned-scope samples, retrieve status, and review approved sample metadata.
Reports and COAs	List published report metadata and download approved published files.
Clients, projects, or locations	Retrieve approved reference data if your tenant uses those structures.
Analysis or service metadata	Retrieve approved service/reference metadata for integrations that need consistent labels.
Audit or status metadata	Review supported status fields or audit-facing metadata where enabled.

Endpoint paths, filters, response shapes, pagination, and error codes are provided during onboarding or in tenant-specific API documentation after verification.

Endpoint reference pages#

These read-only API references define the customer-facing boundary for optional tenant-scoped access:

Each reference page uses GET examples only and placeholder identifiers until a tenant-specific implementation is confirmed for that tenant.

Explicit exclusions#

Read-only customer API documentation must not expose or imply access to:

creating or registering samples;
entering, importing, amending, or deleting results;
receiving, verifying, publishing, retracting, or otherwise changing workflow state;
user, group, role, permission, or account administration;
setup or master-data administration;
raw upstream platform routes or internal administrative endpoints;
bulk export beyond approved scoped export endpoints;
unscoped client, sample, report, or audit data.

If an integration appears to require one of these capabilities, treat it as a scoped implementation project rather than standard customer API access.

Support path#

For access requests, open a Clearline Support ticket with:

the integration owner and technical contact;
the business purpose for API access;
the tenant, client, lab, or role scope needed;
the data areas requested;
expected query volume and schedule;
whether the integration will store downloaded data outside Clearline LIMS.

Clearline Support will confirm whether read-only API access is available for the tenant and what onboarding, credential handling, and confirmation steps are required.