Skip to navigation

samples-v1

View as Markdown

List samples

Retrieve a page of sample records, including sample identifiers, product details, status, and dates. Use this request to inspect sample progress before retrieving laboratory results with results-v1.

Request: GET {{baseUrl}}/{{samples}}
Success: 200 OK with a JSON body. The recorded response media type is text/plain;charset=utf-8. No request body is used.

Query parameters

ParameterFormatUsage
api_tokenStringCredential for the selected environment, supplied through {{api_token}}.
pageInteger in the query stringPage to retrieve. The saved request starts at 1.
sample_idStringSample identifier filter. The saved request sends an empty value.
sample_submission_idStringSample-submission row identifier filter. The saved request sends an empty value.
start_dateYYYY-MM-DDStart of the requested date range. Replace the saved example date with your intended range.
end_dateYYYY-MM-DDEnd of the requested date range. Replace the saved example date with your intended range.

The saved request demonstrates a date range with blank identifier filters. Use the id filters to retrieve specific samples based on the sample_id (lab number) from the laborotory or use the submission_id returned from a successful submission post request.

Response envelope

FieldObserved typeDescription
pageStringReturned page number, for example "1".
hasNextPageBooleanIndicates whether another page is available.
samplesArray of objectsSample records in this page.

Keep filters unchanged while paging. Increment page when hasNextPage is true and stop when it is false.

Sample fields

Types below reflect the saved response.

FieldObserved typeDescription
sample_idStringDownstream sample identifier. Repeated values occur in the recorded data; do not assume it uniquely identifies a response row.
sample_submission_idStringSample-submission row identifier. Recorded values include ""; a usable mapping is not guaranteed.
submitted_atStringSubmission date and time as display text.
collected_atStringCollection date and time as display text.
descriptionStringSample description; may be empty.
product_idStringProduct identifier returned by the service.
product_descriptionStringProduct description; may be empty. The draft POST uses the different field name product_desc.
lotStringLot reference. Preserve as text.
request_numberStringRequest reference; may be empty.
statusStringSample status. completed appears in the saved response; the full set is unspecified.
due_dateStringDue date and time as display text.
validation_dateStringValidation date and time as display text.

Date strings such as Aug 25, 2026 6:30 pm have no timezone offset. They differ from the UTC timestamp in the draft creation response. Preserve the original value unless an agreed parsing convention is available.

Saved example

The attached 200 example contains synthetic sample data and illustrates hasNextPage: true. Use the response flag to determine whether to continue.

Use results-v1 for test-level values, units, and specifications. Preserve the identifiers returned by the service; do not replace sample_id with client_sample_ref, line_number, or the parent submission_id.

Query parameters

api_tokenstringOptional
pageintegerOptional
sample_idstringOptional
sample_submission_idstringOptional
start_datestringOptional
end_datestringOptional

Response

OK