Skip to main content
GET
/
api
/
v2
/
kits
/
{public_id}
cURL
curl --request GET \
  --url https://app.spotdx.com/api/v2/kits/{public_id}/ \
  --header 'Authorization: <api-key>'
{
  "kit_id": "SPOT123456",
  "type": "example_lipid_kit",
  "status": "delivered",
  "events": [
    {
      "status": "awaiting_collection",
      "created": "2023-01-01T04:30:11.222Z"
    },
    {
      "status": "in_transit",
      "created": "2023-01-05T04:30:11.222Z"
    },
    {
      "status": "delivered",
      "created": "2023-01-06T04:30:11.222Z"
    },
    {
      "status": "registered",
      "created": "2023-01-06T04:30:11.222Z"
    },
  ],
  "shipment_to_customer": {
    "tracking_number": "9400123456789999876500",
    "carrier": "usps",
    "created": "2023-01-01T04:30:11.222Z"
  },
  "registered_to": {
    "patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
    "first_name": "Alice",
    "last_name": "Smith",
    "date_of_birth": "1990-01-01",
    "sex": "F",
    "email": "[email protected]",
    "phone": "1234567890"
  },
  "sample": {
    "sample_id": "SPOT654321",
    "status": "awaiting_collection",
    "events": [
      {
        "status": "awaiting_collection",
        "created": "2023-01-01T04:30:11.222Z"
      }
    ],
    "type": "adx100",
    "shipments": [
      {
        "tracking_number": "9400123456789999876500",
        "carrier": "usps",
        "created": "2023-01-01T04:30:11.222Z"
      }
    ],
    "panels": ["lipids_panel_complete"],
    "reports": []
  }
}

{
  "kit_id": "SPOT123456",
  "type": "example_lipid_kit",
  "status": "delivered",
  "events": [
    {
      "status": "awaiting_collection",
      "created": "2023-01-01T04:30:11.222Z"
    },
    {
      "status": "in_transit",
      "created": "2023-01-05T04:30:11.222Z"
    },
    {
      "status": "delivered",
      "created": "2023-01-06T04:30:11.222Z"
    },
    {
      "status": "registered",
      "created": "2023-01-06T04:30:11.222Z"
    },
  ],
  "shipment_to_customer": {
    "tracking_number": "9400123456789999876500",
    "carrier": "usps",
    "created": "2023-01-01T04:30:11.222Z"
  },
  "registered_to": {
    "patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
    "first_name": "Alice",
    "last_name": "Smith",
    "date_of_birth": "1990-01-01",
    "sex": "F",
    "email": "[email protected]",
    "phone": "1234567890"
  },
  "sample": {
    "sample_id": "SPOT654321",
    "status": "awaiting_collection",
    "events": [
      {
        "status": "awaiting_collection",
        "created": "2023-01-01T04:30:11.222Z"
      }
    ],
    "type": "adx100",
    "shipments": [
      {
        "tracking_number": "9400123456789999876500",
        "carrier": "usps",
        "created": "2023-01-01T04:30:11.222Z"
      }
    ],
    "panels": ["lipids_panel_complete"],
    "reports": []
  }
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
public_id
string
required

ID of the kit to retrieve.

Response

Success

​
kit_id
string

The unique identifier of the kit.

Example:

"SPOT123456"

​
type
string

The kit's type

Example:

"health_kit_1"

​
status
enum<string>

The new status of the kit.

Available options:
preparing,
in_transit,
delivered,
delivery_exception,
registered,
canceled
Example:

"preparing"

​
events
object[]

A list of all the events that have occurred for this kit.

Example:
[
  {
    "status": "preparing",
    "created": "2023-01-01T04:30:11.222Z"
  },
  {
    "status": "in_transit",
    "created": "2023-01-05T04:30:11.222Z"
  },
  {
    "status": "delivered",
    "created": "2023-01-06T04:30:11.222Z"
  },
  {
    "status": "registered",
    "created": "2023-01-07T04:30:11.222Z"
  }
]
​
shipment_to_customer
object
​
registered_to
object
​
sample
object