Get kit by ID

GET

api

kits

{public_id}

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": "alice123@gmail.com",
    "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": "alice123@gmail.com",
    "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

200

application/json

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

sample.sample_id

string

Example:

"SPOT654321"

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

sample.events

object[]

Example:

[
  {
    "status": "awaiting_collection",
    "created": "2023-01-01T04:30:11.222Z"
  },
  {
    "status": "in_transit",
    "created": "2023-01-10T04:30:11.222Z"
  },
  {
    "status": "delivered",
    "created": "2023-01-11T04:30:11.222Z"
  },
  {
    "status": "received",
    "created": "2023-01-12T04:30:11.222Z"
  },
  {
    "status": "resulted",
    "created": "2023-01-13T04:30:11.222Z"
  }
]

sample.type

enum<string>

Available options:

adx100,

adx100_2,

adx100_4,

whatman903_10,

dry_transport_swab,

hemaspot_hf,

saliva_3

Example:

"adx100"

sample.shipments

object[]

sample.panels

string[]

The panel codes of the test being performed on the sample. We'll create these with you during onboarding.

Example:

["PANEL-123"]

sample.reports

array

sample.reports.report_id

string

sample.reports.results

object[]

Example:

[
  {
    "result_type": "quantity",
    "name": "HDL Cholesterol",
    "time_collected": "2023-01-14T04:30:11.222Z",
    "result": 123,
    "unit_of_measure": "mg/dL",
    "range_minimum": 20,
    "range_maximum": 200,
    "comments": null
  },
  {
    "result_type": "quantity",
    "name": "Vitamin B12",
    "time_collected": "2023-01-14T04:30:11.222Z",
    "result": "<10",
    "unit_of_measure": "pg/mL",
    "range_minimum": 20,
    "range_maximum": 200,
    "comments": null
  },
  {
    "result_type": "reactivity",
    "name": "Chlamydia",
    "time_collected": "2023-01-14T04:30:11.222Z",
    "result": "negative",
    "unit_of_measure": null,
    "range_minimum": null,
    "range_maximum": null,
    "comments": null
  },
  {
    "result_type": "genotype",
    "name": "rs1234567",
    "time_collected": "2023-01-14T04:30:11.222Z",
    "result": "TT",
    "unit_of_measure": null,
    "range_minimum": null,
    "range_maximum": null,
    "comments": null
  }
]

sample.reports.pdf

string | null

A URL to the PDF report.

Example:

"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf"

sample.reports.txt

string | null

A URL to the TXT report.

Example:

"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"

sample.reports.date_collected

string

sample.reports.date_received

string

sample.reports.date_resulted

string

sample.reports.is_amendment

boolean

Whether this report is an amendment to a previous report.

Example:

false

List kits Create requisition

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": "alice123@gmail.com",
    "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": []
  }
}

Welcome

Basic Guides

Advanced Guides

Integrations

API Reference - Orders

API Reference - Kits

API Reference - Requisitions

API Reference - Registration

Get kit by ID

Authorizations

Path Parameters

Response