Spot home pagelight logo
  1. API Reference - Kits
  2. List kits
GET

/api/v2/kits/

results
offset
email
first_name
kit_type
last_name
phone
has_order
kit_status
sample_status
created_before
created_after
updated_before
updated_after
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

results
integer

Number of results to return per page. Must be in range 1-100. Default is 10.

offset
integer

The initial index from which to return the results.

email
string

Only retrieve kits associated with this email address. Case insensitive.

first_name
string

Only retrieve kits associated with this first name. Case insensitive.

kit_type
string

Only retrieve kits associated with this kit type.

last_name
string

Only retrieve kits associated with this last name. Case insensitive.

phone
string

Only retrieve kits associated with this phone number.

has_order
boolean

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.

kit_status
string

Only retrieve kits whose most recent event is this status.

sample_status
string

Only retrieve kits whose sample's most recent event is this status.

created_before
string

Only retrieve orders created on or before this date. Format: YYYY-MM-DD

created_after
string

Only retrieve orders created on or after this date. Format: YYYY-MM-DD

updated_before
string

Only retrieve orders updated on or before this date. Format: YYYY-MM-DD

updated_after
string

Only retrieve orders updated on or after this date. Format: YYYY-MM-DD

​
Response

array