Returns the current status of a given lab order

GET /orders/{orderId}

Should only be invoked for verified users (logged into account or verified email address)

Path parameters

  • orderId string(uuid) Required

    UUID of an order that has been sent to a lab

Responses

  • returns current status of the lab order

    Hide response attribute Show response attribute object
    • status string

      Status enum to indicate if the lab result is in progress, sample material has been found invalid, or if it has a positive or negative result

      Values are POSITIVE, WEAK_POSITIVE, NEGATIVE, INVALID, or IN_PROGRESS.

  • API key invalid or missing

    Hide headers attribute Show headers attribute
  • no order for the given id found

  • General error response body

    Hide response attribute Show response attribute object
GET /orders/{orderId}
curl \
 -X GET https://api.labres.dev.healthmetrix.com/v1/orders/{orderId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "status": "POSITIVE"
}
Response examples (200)
{
  "status": "POSITIVE"
}
Response examples (500)
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}