> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listaa biomarkkerit

> Selaa biomarkkeriluetteloa

Palauttaa sivutetun luettelon biomarkkereista, jotka API-avaimesi voi tilata yhdelle alkuperälle. Liitä ne [ajanvarauksiin](https://docs.anivahealth.com/fi/api/appointments/add-individual-biomarkers.md) tai [kotitestipakkauksiin](https://docs.anivahealth.com/fi/api/home-kit-orders/add-individual-biomarkers.md). Arkistoidut biomarkkerit on jätetty pois.

Biomarkkeri näkyy luettelossa, kun avaimesi käytettävissä olevan laboratorion tilaus tuottaa sen ja tilauksen näyte otetaan vain näyteastioihin, joita alkuperällä on. Näyteputket ratkaisevat, ei analyytin tyyppi.

Vaatii `panels_access`-käyttöoikeuden. `pricing`-objekti vaatii lisäksi `prices_view`-käyttöoikeuden.

## Pyyntö

### Kyselyparametrit

Alkuperällä on kaksi mahdollista muotoa: testauspiste tai kotitestipakkaus. Lähetä tarkalleen yksi. Jos et lähetä kumpaakaan tai lähetät molemmat, pyyntö palauttaa koodin `400`.

> [tab] Testauspiste
>
> **location\_id** `string` *required*
>
> Toimipiste, jossa ajanvarausten näytteet otetaan. Biomarkkeri näkyy luettelossa, kun sen
> tilauksen näyte otetaan vain näyteastioihin, joita kyseisellä toimipisteellä on. Yhdistä
> [Listaa toimipisteet](https://docs.anivahealth.com/fi/api/locations/list-locations.md) -luetteloon.

> [tab] Kotitestipakkaus
>
> **home\_kit** `boolean` *required*
>
> Aseta arvoksi `true`. Biomarkkeri näkyy luettelossa, kun kotitestipakkauksia käsittelevän
> laboratorion tilauksen näyte otetaan vain pakkauksen sisältämiin näyteastioihin:
> kapillaariseerumi ja EDTA, kuivaverinäyte, virtsa ja pyyhkäisynäyte. Vain laskimonäytteestä
> mitattavat biomarkkerit jäävät pois.

**rate\_card** `string`

Ohita `price_cents`-kentän käyttämä hinnasto: `retail` tai sellaisen hinnaston `id`, jota avaimesi saa käyttää. [Hae hinnasto](https://docs.anivahealth.com/fi/api/pricing/get-rate-card.md) palauttaa kyseisen `id`-tunnisteen. Oletuksena käytetään API-avaimesi laskutustilin hinnastoa, muussa tapauksessa vähittäishinnastoa.
`retail_cents` käyttää aina vähittäishinnastoa.

**limit** `number`

Palautettavien tulosten enimmäismäärä (1–1 000). Jätä pois palauttaaksesi koko vastaavan
luettelon – se on rajattu (enintään muutama tuhat riviä). Kun parametri jätetään pois,
`pagination.limit` palauttaa arvon `total`.

**offset** `number` (default: 0)

Sivutuksen siirtymä. On oltava ≥ 0.

## Vastaus

**data** `Biomarker[]`

Taulukko kyselyä vastaavista biomarkkereista.

**Biomarkkerin kentät**

**id** `number`

Pysyvä biomarkkerin tunniste – välitä tämä [Lisää mukautettuja
biomarkkereita](https://docs.anivahealth.com/fi/api/appointments/add-individual-biomarkers.md) -kutsuun.

**slug** `string`

URL-yhteensopiva tunniste.

**name** `string`

Näyttönimi.

**description** `string | null`

Pitkä kuvaus, jos saatavilla.

**primary\_category** `string | null`

Ensisijainen kategoria (esim. `Hormones`, `Vitamins`).

**secondary\_category** `string | null`

Toissijainen kategoria.

**type** `"clinical" | "genetic"`

Onko tämä biomarkkeri kliininen mittaus vai geneettinen markkeri.

**material** `string | null`

Vaadittu näytemateriaali (esim. `serum`, `whole_blood`).

**unit** `object | null`

Oletusmittayksikkö. Käytä `id`-tunnistetta viitataksesi [Listaa yksiköt](https://docs.anivahealth.com/fi/api/units/list-units.md)
-luetteloon, jos tarvitset pysyvän tunnisteen nimimuutoksista huolimatta.

**Yksikön kentät**

**id** `number`

Pysyvä mittayksikön tunniste.

**title** `string`

Yksikön vakiomuotoinen nimi (esim. `nmol/L`).

**display\_title** `string | null`

Käyttäjäystävällinen näyttönimi.

**pricing** `object | null`

Mitä tämä biomarkkeri maksaa ja miten sitä myydään – katso [hintaobjektit](#hintaobjektit).
`null` **vain**, kun avaimeltasi puuttuu `prices_view`-käyttöoikeus; biomarkkeri, jota Aniva
ei ole hinnoitellut, palautetaan silti arvolla `pricing.price_cents: null`.

**pagination** `object`

**Sivutuksen kentät**

**total** `number`

Kyselyä vastaavien rivien kokonaismäärä kaikilla sivuilla.

**limit** `number`

Tälle sivulle sovellettu enimmäismäärä. Palauttaa arvon `total`, kun `limit`-kyselyparametri
jätettiin pois (koko luettelo palautettiin).

**offset** `number`

Tälle sivulle sovellettu siirtymä.

**has\_more** `boolean`

`true`, kun sivuja on saatavilla lisää.

## Hintaobjektit

Hinnoittelulla on sama rakenne kaikkialla, missä se esiintyy – biomarkkereissa, paneeleissa,
ajanvarauksen [esikatselussa](https://docs.anivahealth.com/fi/api/appointments/preview-containers.md) ja [hintatarjouksessa](https://docs.anivahealth.com/fi/api/pricing/quote-cart.md). [Hinnoittelu](https://docs.anivahealth.com/fi/concepts/pricing.md) selittää sen
taustalla olevan mallin; tämä on kenttäkuvaus.

Kaikki summat ovat kokonaislukuja sentteinä.

**price\_cents** `integer | null`

Mitä tämä maksaa **sinun** hinnastollasi. `0` on todellinen nollahinta – kohdetta ei myydä
erikseen, ja sen vieressä oleva `requires`- tai `positions`-lohko kertoo, miten sitä sen sijaan
myydään. `null` on eri asia: Aniva ei ole hinnoitellut sitä, se ei ole maksuton, sitä ei voi
tilata eikä se lisää mitään mihinkään loppusummaan.

**retail\_cents** `integer | null`

Sama summa suositellussa vähittäishinnastossa. Aina mukana; yhtä suuri kuin `price_cents`, kun
avaimesi käyttää jo vähittäishinnastoa.

**tier** `"routine" | "specialty"`

Kumpi hinnastosi kahdesta Aniva-hintatasosta hinnoitteli tämän markkerin. Mukana vain, kun sillä
on oma hinta.

**positions** `object[]`

Tämän biomarkkerin sisältävät kaupalliset tarjoukset halvin ensin. Kun `price_cents: 0`, nämä
ovat ainoa tapa tilata se; kun `price_cents` on positiivinen, nämä ovat paketit, joihin se myös
kuuluu. Positio laskutetaan **kerran** ja toimitetaan aina kokonaisena.

**id** `string`

Pysyvä nimiketunniste. Yhdistyy ajanvarauksen laskun `via_position`-kenttään.

**name** `string`

Kumppanille näkyvä nimikkeen nimi.

**price\_cents** `integer | null`

Koko nimikkeen hinta hinnastossasi, laskutetaan kerran. Sen rinnalla on `retail_cents`.

**biomarker\_ids** `number[]`

Kaikki biomarkkerit, jotka nimike sisältää, mukaan lukien hakemasi biomarkkeri.

**includes** `number[]`

Muut jäsenet kuin hakemasi biomarkkeri — eli mitä tulee mukana, kun ostat sen.

**requires** `object[]`

Mukana, kun tämä biomarkkeri on **suhdeluku**. Sen tilaaminen lisää nämä komponentit ostoskoriin
niiden omilla hinnoilla, ja komponentti maksetaan kerran ostoskoria kohden riippumatta siitä, kuinka moni suhdeluku käyttää sitä.
Suhdeluvun oma `price_cents` laskutetaan komponenttien lisäksi. Useimmat suhdeluvut maksavat `0`. Jokainen
merkintä sisältää kentät `id`, `name`, `price_cents` ja `retail_cents`.

Suhdeluku, jonka kaikkia komponentteja ei ole hinnoiteltu, puuttuu luettelosta kokonaan — se ei
koskaan näy arvolla `price_cents: null`.

Paneeleilla on vain `price_cents` ja `retail_cents`: paneelilla on yksi luettelohinta eikä
nimikkeitä tai komponentteja.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe — esim. alkuperä puuttuu tai alkuperiä on kaksi, `limit` on alueen ulkopuolella tai `rate_card` on tuntematon tai luvaton. |
| `403` | Kielletty — `panels_access`-scope puuttuu. |
| `404` | `location_id` ei vastaa yhtään testipaikkaa. |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL theme={null}
curl --url 'https://anivahealth.com/api/v1/biomarkers?home_kit=true&limit=5' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "data": [
    {
      "id": 42,
      "slug": "vitamin-d-25-oh",
      "name": "Vitamin D (25-OH)",
      "description": "Serum 25-hydroxyvitamin D …",
      "primary_category": "Vitamins",
      "secondary_category": null,
      "type": "clinical",
      "material": "serum",
      "unit": { "id": 1, "title": "nmol/L", "display_title": null },
      "pricing": {
        "price_cents": 3952,
        "retail_cents": 4549,
        "tier": "specialty",
        "positions": [
          {
            "id": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d",
            "name": "Vitamin panel",
            "price_cents": 6900,
            "retail_cents": 7935,
            "biomarker_ids": [42, 43, 44],
            "includes": [43, 44]
          }
        ]
      }
    }
  ],
  "pagination": { "total": 17, "limit": 5, "offset": 0, "has_more": true }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.