Get Available Tests

GET lab tests the team has access to as a paginated list.

Python

from vital.client import Vital
from vital.environment import VitalEnvironment

client = Vital(
  api_key="YOUR_API_KEY",
  environment=VitalEnvironment.SANDBOX
)

data = client.lab_tests.get_paginated();

Response

{
  "data": [
    {
      "lab_test": {
        "name": "Lipids Panel",
        "description": "Cholesterol test",
        "sample_type": "dried blood spot",
        "method": "testkit",
        "price": 10,
        "is_active": true,
        "lab": {
          "slug": "USSL",
          "name": "US Specialty Lab",
          "first_line_address": "123 Main St",
          "city": "New York",
          "zipcode": "10001"
        },
        "markers": [
          {
            "name": "Thyroid Stimulating Hormone",
            "slug": "tsh",
            "description": ""
          }
        ]
      }
    }
  ],
  "next_cursor": null
}

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Query Parameters

lab_test_limit · integer · default: 50

next_cursor · string | null

The cursor for fetching the next page, or null to fetch the first page.

generation_method · enum<string>

Filter on whether auto-generated lab tests created by Vital, manually created lab tests, or all lab tests should be returned.

Available options:

auto,

manual,

all

lab_slug · string | null

Filter by the slug of the lab for these lab tests.

collection_method · enum<string> | null

Filter by the collection method for these lab tests. The method used to perform a lab test. ℹ️ This enum is non-exhaustive.

Available options:

testkit,

walk_in_test,

at_home_phlebotomy,

on_site_collection

status · enum<string> | null

Filter by the status of these lab tests. ℹ️ This enum is non-exhaustive.

Available options:

active,

pending_approval,

inactive

marker_ids · integer[] | null

Filter to only include lab tests containing these marker IDs.

provider_ids · string[] | null

Filter to only include lab tests containing these provider IDs.

name · string | null

Filter by the name of the lab test (a case-insensitive substring search).

order_key · enum<string> | null

Available options:

price,

created_at,

updated_at

order_direction · enum<string> · default: asc

Available options:

asc,

desc

Response

200

application/json

Successful Response

data · ClientFacingLabTest · object[] · required

Show child attributes

next_cursor · string | null · required

The cursor for fetching the next page, or null to fetch the first page.