On this page
Clients and projects API — read-only
Use the clients and projects API only to retrieve authorized reference records needed by an approved integration. 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 authorized clients#
GET /api/v1/clients?page=1&page_size=50 HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer EXAMPLE_READ_ONLY_TOKEN
Accept: application/json
This request returns client records visible to the provisioned scope. Some tenants may not expose client records through read-only API access.
Retrieve one client#
GET /api/v1/clients/CLIENT-EXAMPLE-001 HTTP/1.1
Host: api.example.clearlinelims.test
Authorization: Bearer EXAMPLE_READ_ONLY_TOKEN
Accept: application/json
Use this request to retrieve one authorized client record.
List projects or locations#
GET /api/v1/projects?client_id=CLIENT-EXAMPLE-001&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 only where project, location, submitter, or work-order structures are enabled and approved for your tenant.
Typical fields#
| Field | Meaning |
|---|---|
client_id | Authorized client identifier. |
project_id | Authorized project or work-order identifier, where enabled. |
name | Customer-facing client, project, or location label. |
status | Active, inactive, or another supported read-only state. |
updated_at | Last exposed metadata update timestamp. |
Boundary notes#
Client and project API access does not grant broad directory visibility. Responses are limited to the provisioned scope and the data areas Clearline approves during onboarding.
Not supported in read-only access#
This API does not create clients, edit client records, administer contacts, change projects, update locations, manage billing, or alter setup data. Request those changes through Clearline Support.