Skip to main content
GET
/
api
/
v1
/
appointments
/
{id}
/
preview
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'
{
  "tubes": [
    {
      "type": "serum",
      "name": "Serum",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "count": 2
    },
    {
      "type": "glucose",
      "name": "Glucose",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": null
}
Preview the blood collection tubes required for an appointment based on its currently attached panels and biomarkers. This runs the logistics pipeline in preview mode — no orders are placed. Use this endpoint after adding panels or custom biomarkers to see what physical tubes the practitioner needs to prepare for the blood draw.
The response includes routing and pricing fields that are currently always null. They are reserved for a future release — do not rely on these fields being populated.

Request

Path parameters

id
string
required
Unique identifier (UUID) of the appointment to preview tube requirements for.

Response

On success, the API returns 200 OK with the tube requirements and reserved fields for future use.
tubes
object[]
required
Array of required blood collection tubes. Empty when no panels or biomarkers have been added to the appointment.
routing
null
Lab routing details. Reserved for future use, currently always null.
pricing
null
Pricing breakdown. Reserved for future use, currently always null.

Error responses

StatusDescription
400Invalid ID format — the provided value is not a valid UUID.
403Forbidden — your API key does not have access to this operation.
404Appointment not found.
500Internal server error.
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'
{
  "tubes": [
    {
      "type": "serum",
      "name": "Serum",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "count": 2
    },
    {
      "type": "glucose",
      "name": "Glucose",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": null
}