Retrieve a list of requisitions.

get/api/v2/requisitions/

Request

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

Query parameters

labstring

Filter by the lab name. This is case sensitive. If there is a space in the lab's name, use %20 in the url instead, eg. The Lab would become ?lab=The%20Lab

first_namestring

Filter by first name.

last_namestring

Filter by last name.

emailstring

Filter by email.

phonestring

Filter by phone number.

statusstring

Filter by 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

offsetinteger

The offset to start the list from.

resultsinteger

The number of results to retrieve per page.

Response

requisition_idstring

The ID of the requisition.

barcodestring

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

account_numberstring

The account number submitted to the lab.

labstring

The name of the lab that will process the sample.

panelsstring[]

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

status'created' | 'approved' | 'denied' | 'delivered' | 'received' | 'extra_quality_checks' | 'resulted' | 'rejected' | 'delivery_exception'
createdstring date-time
updatedstring date-time

Example response

[
  {
    "requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
    "barcode": "19742938328",
    "account_number": "1234567890",
    "lab": "CRL",
    "panels": [
      "PANEL-123"
    ],
    "patient": {
      "first_name": "Alice",
      "last_name": "Smith",
      "email": "alice123@gmail.com",
      "phone": "1234567890",
      "sex": "F",
      "address": {
        "street1": "123 Main St",
        "street2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94105"
      }
    },
    "status": "resulted",
    "created": "2020-01-01T00:00:00Z",
    "updated": "2020-01-01T00:00:00Z"
  }
]

Changes

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