List Panels (v2)

GET

api

panels

curl --url 'https://anivahealth.com/api/v2/panels' \
  --header 'x-api-key: YOUR_API_KEY'

[
  {
    "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
    "name": "Hormones (Female)",
    "biomarker_groups": [
      { "biomarker_ids": [42], "required": true, "inclusion_condition": null },
      { "biomarker_ids": [43, 44], "required": true, "inclusion_condition": null },
      { "biomarker_ids": [51], "required": true, "inclusion_condition": "sex=2" },
      { "biomarker_ids": [52], "required": false, "inclusion_condition": null }
    ],
    "pricing": {
      "retail": {
        "total_cents": 14900,
        "groups": [{ "price_cents": 14900, "biomarker_ids": [] }]
      },
      "yours": {
        "total_cents": 11900,
        "groups": [{ "price_cents": 11900, "biomarker_ids": [] }]
      }
    }
  },
  {
    "id": "9c1d2e3f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
    "name": "Custom",
    "biomarker_groups": [],
    "pricing": null
  }
]

The same catalog as List Panels, describing each panel as the groups it requires rather than a flat list of biomarker IDs. A group holds interchangeable biomarkers, and exactly one of them is measured — hs-CRP or CRP, serum or EDTA plasma. Which one is decided per draw by lab routing. So v1’s flat biomarker_ids over-states what a draw returns: a panel listing 120 IDs delivers around 90 results.

Count groups, not biomarker IDs, when telling a patient what they get — and read required first. An optional group is ordered only when a routing Aniva is already paying for can carry it, so it may never be delivered.

v1 is not deprecated and keeps serving the flat union of every group’s members.

Request

Query parameters

string

Override which rate card the yours price uses: retail, subscription, or a billing-account slug your key may use. Defaults to the card on your API key’s billing account, else retail.

test_location_id is not accepted here. v1 only validated that it existed — panel pricing is location-independent.

Response

Returns an array of panels.

string

Stable panel identifier (UUID) — pass this to Add Panels.

string

Display name.

object[]

What the panel requires. Empty for custom container panels — their membership lives per-appointment, so use Add Individual Biomarkers.

Show group

number[]

Interchangeable ways to satisfy the group. Exactly one is measured. Cross-reference against List Biomarkers.

boolean

A required group is always ordered. false means optional — ordered opportunistically, and possibly not at all.

string | null

Demographic gate on the whole group, evaluated against the patient when the panel is attached to an appointment: sex=2, age>50, combinable with && / || (sex is ISO/IEC 5218 — 1 male, 2 female). null applies to everyone. The catalog has no patient in context, so gated groups are listed here ungated — Preview Containers is the patient-aware answer.

object | null

Per-panel pricing — null unless your key has the prices_view scope, or for panels without a fixed catalog price (e.g. the custom container). Carries retail and yours, each a price breakdown (a single group, no goa_lines) or null.

Error responses

Status	Description
`400`	Validation error — e.g. unknown/unauthorised `rate_card`.
`403`	Forbidden — missing `panels_access` scope.
`500`	Internal server error.

curl --url 'https://anivahealth.com/api/v2/panels' \
  --header 'x-api-key: YOUR_API_KEY'

[
  {
    "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
    "name": "Hormones (Female)",
    "biomarker_groups": [
      { "biomarker_ids": [42], "required": true, "inclusion_condition": null },
      { "biomarker_ids": [43, 44], "required": true, "inclusion_condition": null },
      { "biomarker_ids": [51], "required": true, "inclusion_condition": "sex=2" },
      { "biomarker_ids": [52], "required": false, "inclusion_condition": null }
    ],
    "pricing": {
      "retail": {
        "total_cents": 14900,
        "groups": [{ "price_cents": 14900, "biomarker_ids": [] }]
      },
      "yours": {
        "total_cents": 11900,
        "groups": [{ "price_cents": 11900, "biomarker_ids": [] }]
      }
    }
  },
  {
    "id": "9c1d2e3f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
    "name": "Custom",
    "biomarker_groups": [],
    "pricing": null
  }
]

curl --url 'https://anivahealth.com/api/v2/panels' \
  --header 'x-api-key: YOUR_API_KEY'

[
  {
    "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
    "name": "Hormones (Female)",
    "biomarker_groups": [
      { "biomarker_ids": [42], "required": true, "inclusion_condition": null },
      { "biomarker_ids": [43, 44], "required": true, "inclusion_condition": null },
      { "biomarker_ids": [51], "required": true, "inclusion_condition": "sex=2" },
      { "biomarker_ids": [52], "required": false, "inclusion_condition": null }
    ],
    "pricing": {
      "retail": {
        "total_cents": 14900,
        "groups": [{ "price_cents": 14900, "biomarker_ids": [] }]
      },
      "yours": {
        "total_cents": 11900,
        "groups": [{ "price_cents": 11900, "biomarker_ids": [] }]
      }
    }
  },
  {
    "id": "9c1d2e3f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
    "name": "Custom",
    "biomarker_groups": [],
    "pricing": null
  }
]

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

List Panels (v2)

Request

Query parameters

Response

Error responses

​Request

​Query parameters

​Response

​Error responses

Request

Query parameters

Response

Error responses