GET
/
api
/
v2
/
kits
/
Authorization
Query
curl --request GET \
  --url https://app.spotdx.com/api/v2/kits/ \
  --header 'Authorization: <authorization>'
[
  {
    "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"
  }
]

Authorizations

Authorizationheaderrequired
string

Token-based authentication with required prefix "Token"

Query 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
enum<string>

Only retrieve kits whose most recent event is this status.

Available options:
preparing,
in_transit,
delivered,
delivery_exception,
registered,
canceled
sample_status
enum<string>

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

Available options:
awaiting_collection,
collection_exception,
delivery_exception,
delivered,
in_transit,
received,
resulted,
partially_resulted,
extra_quality_checks,
canceled
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

200 - application/json
created
string

The date and time the kit was created.

kit_id
string

The unique identifier of the kit.

kit_status
enum<string>

The new status of the kit.

Available options:
preparing,
in_transit,
delivered,
delivery_exception,
registered,
canceled
kit_type
string

The kit's type

order_id
string | null

The order the kit belongs to.

sample_status
enum<string>

The new status of the sample.

Available options:
awaiting_collection,
collection_exception,
delivery_exception,
delivered,
in_transit,
received,
resulted,
partially_resulted,
extra_quality_checks,
canceled
updated
string

The date and time the kit was last updated.

Update order metadataGet kit by ID