Skip to main content
GET
Retrieve clinical and genetic lab results for a home kit order, along with document references for lab report PDFs. Every biomarker ordered for the kit appears in the response, so you can track the whole order rather than only what has come back. Results file under the order’s lab_code — the laboratory order is placed at activation, and the lab reports markers individually as they are analysed, so a partial payload is normal and the top-level status stays in_progress until the final report. Read status on each result before using its value:
  • Tests still outstanding appear with status planned while the order is in_progress. You can call this endpoint before activation — every ordered marker is then planned.
  • Results the lab delivered but that must not be used clinically appear with status fault or undeliverable, and carry a status_reason explaining why. A fault result still has its value populated — that value is wrong. Never present it as a finding.
Use Download Document to download lab report PDFs referenced in the documents array. You do not need to poll this endpoint. Subscribe to home_kit_order.results.updated or home_kit_order.results.completed webhooks, and call it when an event arrives. Polling still works as a fallback. Requires the results_view scope — lab results and documents are always gated by it, the same as appointment results and Download Document — plus the home_kit_orders_view or home_kit_orders_manage scope to access the kit order itself.

Request

Path parameters

string
required
Unique identifier (UUID) of the home kit order to retrieve results for.

Response

On success, the API returns 200 OK with the results object.
string
required
Overall results status. One of:
  • in_progress — some requisitions are still at the laboratory.
  • completed — every requisition has closed and at least one reported.
  • fault — every requisition died without reporting. Nothing is owed.
object[]
required
One entry per laboratory requisition — a draw spanning several tubes or laboratories has several. The top-level status is completed once every entry has closed and one reported.
object[]
required
Array of clinical biomarker results.
object[]
required
Array of genetic biomarker results.
object[]
required
Lab report documents. Use GET /api/v1/documents/{id} to download each file.

Error responses