List kits
Query your kits and return a summary, sorted by creation date. Providing any query params will further filter the results to only those that match the query params.
Authorizations
Token-based authentication with required prefix "Token"
Query Parameters
Number of results to return per page. Must be in range 1-100. Default is 10.
1 < x < 100The initial index from which to return the results.
x > 0Only 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.
preparing, in_transit, delivered, delivery_exception, registered, canceled Only retrieve kits whose sample's most recent event is this status.
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled 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
The unique identifier of the kit.
The kit's type
The order the kit belongs to.
The new status of the kit.
preparing, in_transit, delivered, delivery_exception, registered, canceled The new status of the sample.
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled The date and time the kit was created.
The date and time the kit was last updated.