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.

get/api/v2/kits/

Request

  • Base URL: https://app.spotdx.com
  • URL: https://app.spotdx.com/api/v2/kits/
  • Auth: API key in header Authorization

Query parameters

resultsinteger

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

offsetinteger

The initial index from which to return the results.

emailstring

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

first_namestring

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

kit_typestring

Only retrieve kits associated with this kit type.

last_namestring

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

phonestring

Only retrieve kits associated with this phone number.

has_orderboolean

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'preparing' | 'in_transit' | 'delivered' | 'delivery_exception' | 'registered' | 'canceled'

The new status of the kit.

Example:preparing

Only retrieve kits whose most recent event is this status.

sample_status'awaiting_collection' | 'collection_exception' | 'delivery_exception' | 'delivered' | 'in_transit' | 'received' | 'resulted' | 'partially_resulted' | 'extra_quality_checks' | 'canceled'

The new status of the sample.

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

created_beforestring

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

created_afterstring

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

updated_beforestring

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

updated_afterstring

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

Response

Success

kit_idstring

The unique identifier of the kit.

kit_typestring

The kit's type

order_idstring nullable

The order the kit belongs to.

kit_status'preparing' | 'in_transit' | 'delivered' | 'delivery_exception' | 'registered' | 'canceled'

The new status of the kit.

sample_status'awaiting_collection' | 'collection_exception' | 'delivery_exception' | 'delivered' | 'in_transit' | 'received' | 'resulted' | 'partially_resulted' | 'extra_quality_checks' | 'canceled'

The new status of the sample.

createdstring date-time

The date and time the kit was created.

updatedstring date-time

The date and time the kit was last updated.

Example response

[
  {
    "kit_id": "SPOT123456",
    "kit_type": "health_kit_1",
    "order_id": "O1234567",
    "kit_status": "preparing",
    "created": "2023-01-01T04:30:11.222Z",
    "updated": "2023-01-01T04:30:11.222Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.