API reference

Results

Released lab results, behind the member's consent. 1 operation under /public/v1, with parameters, request bodies and example responses.

Paths are relative to the API host: https://sandbox-api.clivehealth.app for the sandbox, https://api.clivehealth.app for production. Send Authorization: Bearer <token> on every request (Getting started).

Operations

Released results of a member

GET/public/v1/members/{id}/results

Scope results:readOperation getMemberResults

Newest first, at most 50. Needs the member's consent to share results with you (share_results_<your provider>, e.g. share_results_partner_v1): without it the answer is 403 CONSENT_REQUIRED. Every read is logged on the member's sharing log.

Requires scope results:read.

Parameters

getMemberResults parameters
NameInTypeDescription
idrequiredpathstring (uuid)Clive member id.

Responses

200The member's released results.Returns MemberResults.

getMemberResults 200 response
FieldTypeDescription
datarequiredarray of ReleasedResult
result_idrequiredstring (uuid)The lab order whose results were released.
lab_namerequiredstring or null
released_atrequiredstring (date-time)
valuesrequiredarray of LabValue
analyterequiredstring
value_numericrequirednumber or null
value_textrequiredstring or null
unitsrequiredstring or null
reference_lowrequirednumber or null
reference_highrequirednumber or null
flagrequiredstring or nullH, L, A or N against the reference range; display only, not a diagnosis.
observed_atrequiredstring (date-time)
report_urlrequiredstring or nullSigned link to the report PDF, valid for one hour; null without a PDF.
report_url_expires_atrequiredstring (date-time) or null
Response 200JSON
{
  "data": [
    {
      "result_id": "0b8e3c6a-2d4f-4e1b-9a7c-5d3e1f2a4b6c",
      "lab_name": "Clive Clinic KL Sentral laboratory",
      "released_at": "2026-10-24T01:30:00.000Z",
      "values": [
        {
          "analyte": "Glucose (fasting)",
          "value_numeric": 5.2,
          "value_text": null,
          "units": "mmol/L",
          "reference_low": 3.9,
          "reference_high": 5.6,
          "flag": "N",
          "observed_at": "2026-10-24T01:30:00.000Z"
        }
      ],
      "report_url": "https://files.example.com/reports/8c1e…?signature=…",
      "report_url_expires_at": "2026-10-24T02:00:00.000Z"
    }
  ]
}
getMemberResults error responses
StatusMeaning
400Malformed request or invalid cursor.
401Missing, invalid or expired access token, or the API client was revoked (INVALID_TOKEN).
403The token lacks the scope this operation needs (INSUFFICIENT_SCOPE).
404No such record in this clinic (NOT_FOUND).
422Validation failed (VALIDATION_ERROR).
429Per-client rate limit exceeded (RATE_LIMITED).
500Unexpected error (INTERNAL_ERROR).

Every error body is the error envelope; branch on its code.