TRtryvital
lab_tests

Get Paginated Lab Tests For Team

Changed on

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

get/v3/lab_test

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v3/lab_test
  • Auth
    API key in header x-vital-api-key

Query parameters

lab_test_limitinteger
next_cursorstring nullable

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

include_pricingboolean
lab_account_idstring uuid nullable

The lab account ID. This lab account is used to determine the availability of markers and lab tests.

generation_method'auto' | 'manual' | 'all'

ℹ️ This enum is non-exhaustive.

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

lab_slugstring nullable

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

collection_method'testkit' | 'walk_in_test' | 'at_home_phlebotomy' | 'on_site_collection'

The method used to perform a lab test. ℹ️ This enum is non-exhaustive.

Filter by the collection method for these lab tests.

status'active' | 'pending_approval' | 'inactive'

ℹ️ This enum is non-exhaustive.

Filter by the status of these lab tests.

marker_idsinteger[] nullable

Filter to only include lab tests containing these marker IDs.

provider_idsstring[] nullable

Filter to only include lab tests containing these provider IDs.

namestring nullable

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

order_key'price' | 'created_at' | 'updated_at' nullable
order_direction'asc' | 'desc'

Response

Successful Response

next_cursorstring nullable required

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

Example response

{
  "data": [
    {
      "lab_test": {
        "description": "Cholesterol test",
        "fasting": false,
        "has_collection_instructions": false,
        "is_delegated": false,
        "lab": {
          "city": "New York",
          "first_line_address": "123 Main St",
          "name": "US Specialty Lab",
          "slug": "USSL",
          "zipcode": "10001"
        },
        "markers": [
          {
            "description": "Hemoglobin A1c is a form of hemoglobin that is measured identify your average blood sugar levels over the past 3 months.",
            "id": 1,
            "lab_id": 1,
            "name": "Hemoglobin A1c",
            "price": "10.00",
            "provider_id": "1234",
            "slug": "hemoglobin-a1c",
            "type": "biomarker",
            "unit": "%"
          }
        ],
        "method": "testkit",
        "name": "Lipids Panel",
        "price": 10,
        "sample_type": "dried blood spot",
        "status": "active"
      },
      "updated_at": "2020-01-01T00:00:00Z"
    }
  ]
}

Changes

  • 8132a215da01Revision changes
    • info

      response property data/items/markers/anyOf[subschema #1]/items/price deprecated

    • info

      response property data/items/price deprecated

  • b1aa5d5cc8c0Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      response property data/items/markers/anyOf[subschema #1]/items/common_tat_days deprecated

    • info

      response property data/items/markers/anyOf[subschema #1]/items/worst_case_tat_days deprecated