- API Reference - Kits
- List kits
API Reference - Kits
List kits
/api/v2/kits/
curl --request GET \
--url https://app.spotdx.com/api/v2/kits/ \
[
{
"kit_id": "SPOT123456",
"kit_type": "health_kit_1",
"order_id": "O1234567",
"kit_status": "preparing",
"sample_status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z"
}
]
Parameters
Number of results to return per page. Must be in range 1-100. Default is 10.
The initial index from which to return the results.
Only retrieve kits associated with this email address. Case insensitive.
Only retrieve kits associated with this first name. Case insensitive.
Only retrieve kits associated with this kit type.
Only retrieve kits associated with this last name. Case insensitive.
Only retrieve kits associated with this phone number.
Filter kits based on whether they are associated with an order. Kit ordered through the API will always have an order. Retail kits may not.
Only retrieve kits whose most recent event is this status.
Only retrieve kits whose sample's most recent event is this status.
Only retrieve orders created on or before this date. Format: YYYY-MM-DD
Only retrieve orders created on or after this date. Format: YYYY-MM-DD
Only retrieve orders updated on or before this date. Format: YYYY-MM-DD
Only retrieve orders updated on or after this date. Format: YYYY-MM-DD
Response
curl --request GET \
--url https://app.spotdx.com/api/v2/kits/ \
[
{
"kit_id": "SPOT123456",
"kit_type": "health_kit_1",
"order_id": "O1234567",
"kit_status": "preparing",
"sample_status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z"
}
]