- API Reference - Kits
- Get kit by ID
API Reference - Kits
Get kit by ID
GET
/api/v2/kits/{public_id}/
public_id*
curl --request GET \
--url https://app.spotdx.com/api/v2/kits/{public_id}/ \
{
"kit_id": "SPOT123456",
"type": "example_lipid_kit",
"status": "preparing",
"events": [
{
"status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z"
},
{
"status": "in_transit",
"created": "2023-01-05T04:30:11.222Z"
},
{
"status": "delivered",
"created": "2023-01-06T04:30:11.222Z"
},
{
"status": "received",
"created": "2023-01-07T04:30:11.222Z"
},
{
"status": "resulted",
"created": "2023-01-08T04:30:11.222Z"
}
],
"shipment_to_customer": {
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
},
"registered_to": {
"patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
"first_name": "Alice",
"last_name": "Smith",
"date_of_birth": "1990-01-01",
"sex": "F",
"email": "alice123@gmail.com",
"phone": "1234567890"
},
"sample": {
"sample_id": "SPOT654321",
"status": "awaiting_collection",
"events": [
{
"status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z"
}
],
"type": "adx100",
"shipments": [
{
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
}
],
"panels": ["lipids_panel_complete"],
"reports": [
"report_id": "string",
"results": [
{
"result_type": "quantity",
"name": "HDL Cholesterol",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": 123,
"unit_of_measure": "mg/dL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "quantity",
"name": "Vitamin B12",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "<10",
"unit_of_measure": "pg/mL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "reactivity",
"name": "Chlamydia",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "negative",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
},
{
"result_type": "DNA",
"name": "rs1234567",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "TT",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
}
],
"pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
"txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt",
"date_collected": "2023-01-16T11:00:09.869Z",
"date_received": "2023-01-16T11:00:09.869Z",
"is_amendment": false
]
}
}
Parameters
public_idRequired
string
ID of the kit to retrieve.
Response
kit_id
string
The unique identifier of the kit.
type
string
The kit's type
status
string
The new status of the kit.
Available options:
preparing
, in_transit
, delivered
, delivery_exception
, registered
, canceled
events
array
A list of all the events that have occurred for this kit.
shipment_to_customer
object
registered_to
object
sample
object
curl --request GET \
--url https://app.spotdx.com/api/v2/kits/{public_id}/ \
{
"kit_id": "SPOT123456",
"type": "example_lipid_kit",
"status": "preparing",
"events": [
{
"status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z"
},
{
"status": "in_transit",
"created": "2023-01-05T04:30:11.222Z"
},
{
"status": "delivered",
"created": "2023-01-06T04:30:11.222Z"
},
{
"status": "received",
"created": "2023-01-07T04:30:11.222Z"
},
{
"status": "resulted",
"created": "2023-01-08T04:30:11.222Z"
}
],
"shipment_to_customer": {
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
},
"registered_to": {
"patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
"first_name": "Alice",
"last_name": "Smith",
"date_of_birth": "1990-01-01",
"sex": "F",
"email": "alice123@gmail.com",
"phone": "1234567890"
},
"sample": {
"sample_id": "SPOT654321",
"status": "awaiting_collection",
"events": [
{
"status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z"
}
],
"type": "adx100",
"shipments": [
{
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
}
],
"panels": ["lipids_panel_complete"],
"reports": [
"report_id": "string",
"results": [
{
"result_type": "quantity",
"name": "HDL Cholesterol",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": 123,
"unit_of_measure": "mg/dL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "quantity",
"name": "Vitamin B12",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "<10",
"unit_of_measure": "pg/mL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "reactivity",
"name": "Chlamydia",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "negative",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
},
{
"result_type": "DNA",
"name": "rs1234567",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "TT",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
}
],
"pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
"txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt",
"date_collected": "2023-01-16T11:00:09.869Z",
"date_received": "2023-01-16T11:00:09.869Z",
"is_amendment": false
]
}
}