POST
/
api
/
v2
/
requisitions
/
Authorization
Body
curl --request POST \
  --url https://app.spotdx.com/api/v2/requisitions/ \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_number": "1234567890",
  "barcode": "19742938328",
  "lab": "CRL",
  "panels": [
    "PANEL-123"
  ],
  "patient": {},
  "state_collected": "OH"
}'
Access to requisitioning is disabled by default. To enable it, talk to us and we’ll get you set up

After creating a new requisition, we will immediately respond with an approved or denied status code.

{
  "requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
  "barcode": "19742938328",
  "account_number": "1234567890",
  "panels": ["PANEL-123"],
  "state_collected": "OH",
  "patient": {
    "first_name": "Alice",
    "last_name": "Smith",
    "email": "alice123@gmail.com",
    "phone": "1234567890",
    "sex": "F",
    "date_of_birth": "2023-02-01",
    "address": {
      "street1": "123 Main St",
      "street2": "Apt 1",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zip": "94105"
    }
  },
  "tracking": {
    "tracking_number": "9400123456789999876500",
    "carrier": "usps"
  },
  "status": "approved",
  "events": [
    {
      "event": "created",
      "date": "2020-01-01T00:00:00Z"
    },
    {
      "event": "approved",
      "date": "2020-01-01T00:00:00Z"
    }
  ],
  "reports": [],
  "metadata": null
}

Authorizations

Authorizationheaderrequired
string

Token-based authentication with required prefix "Token"

Body

application/json
account_numberrequired
string

The account number submitted to the lab.

attributes
object | null

An optional set of values that can be passed through to specific labs.

barcoderequired
string

The barcode of the sample mailed to the lab. We use this to identify the sample from the lab report.

labrequired
string

The name of the lab that will process the sample.

metadata
object | null

An optional dictionary of key-value pairs stored with the requisition.

panelsrequired
string[]

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

patientrequired
object
state_collectedrequired
string

The two letter code of the state where the sample was collected.

tracking
object

Response

200 - application/json
account_number
string

The account number submitted to the lab.

attributes
object | null

An optional set of values that can be passed through to specific labs.

barcode
string

The full barcode of the sample mailed to the lab. Must be globally unique.

created
string
events
object[]
lab
string

The name of the lab that will process the sample.

metadata
object | null

An optional dictionary of key-value pairs stored with the requisition.

panels
string[]

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

patient
object
reports
array
requisition_id
string

The ID of the requisition.

state_collected
string

The two letter code of the state where the sample was collected.

status
enum<string>
Available options:
created,
approved,
denied,
delivered,
received,
extra_quality_checks,
resulted,
rejected,
delivery_exception
tracking
object
updated
string
Get available kit typesList requisitions