> ## 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.

# List opp timer

> Hent timer til blodprøvetaking som API-nøkkelen din har tilgang til

Hent en liste over timer for blodprøvetaking. Hver time inkluderer den innebygde pasientprofilen.

Filtrene kombineres:

* `date` returnerer timene på én kalenderdag. Dagen er den lokale dagen for hvert prøvested, så en blodprøvetaking kl. 23:30 i Berlin teller på datoen i Berlin.
* `location_id` returnerer timene på ett prøvested.
* `profile_id` uten `date` returnerer alle timer for den profilen, uten tidsbegrensning.
* Uten `profile_id` og uten `date` gjelder standard tidsvindu: de siste 2 månedene til 1 måned frem i tid.

Krever scopet `appointments_view` eller `appointments_schedule`.

## Forespørsel

### Spørreparametere

**profile\_id** `string`

Filtrer etter profil-UUID. Når denne oppgis, returneres alle timer for denne profilen uavhengig
av oppsatt dato. Når den utelates, gjelder standard tidsvindu.

**location\_id** `string`

Filtrer etter prøvestedets UUID.

**date** `string`

Kalenderdag i `YYYY-MM-DD`-format, i tidssonen til hvert prøvested. Erstatter
standard tidsvindu. Resultatene sorteres etter `scheduled_at`, tidligst først.

## Respons

Ved suksess returnerer API-et `200 OK` med en liste med timeobjekter.

**id** `string` *required*

Unik timeidentifikator (UUID).

**profile\_id** `string` *required*

UUID for profilen denne timen tilhører.

**location\_id** `string`

UUID for teststedet der blodprøvetakingen finner sted.

**scheduled\_at** `string`

Planlagt tidspunkt for timen i UTC (ISO 8601 med `Z`-suffiks, f.eks.
`2026-05-15T10:30:00Z`). Kan være `null`.

**status** `string` *required*

Gjeldende status for timen. En av `pending`, `confirmed`, `blood_drawn` eller `cancelled`.
Detaljert status for laboratorieresultater henter du fra [Hent resultater](https://docs.anivahealth.com/no/api/appointments/get-results.md),
og mer detaljert fremdrift for forsendelser fra hvert element i den innebygde `shipments`-listen (se nedenfor)
videre til [Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

**cancellation\_reason** `string`

Fritekstårsak som ble registrert da timen ble avbestilt (f.eks. manglende oppmøte, sen avbestilling,
«Mislyktes. Må gjentas»). `null` med mindre `status` er `cancelled`.

**results\_ready\_emails** `string[]` *required*

Adresser som hver får én e-post når alle labresultater er endelige, i små bokstaver. Tom når den er slått av. Se
[E-poster om klare resultater](https://docs.anivahealth.com/no/concepts/results.md#e-poster-nar-resultater-er-klare).

**draw\_method** `string` *required*

Hvordan blodprøven tas: `capillary` (fingertupp eller overarm, i mikrorør) eller `venous` (fra vene,
i prøverør). Det er metoden som er satt på timen, ellers `default_draw_method` for
[stedet](https://docs.anivahealth.com/no/concepts/locations.md). Etter blodprøvetakingen er det metoden som ble brukt.

**created\_at** `string` *required*

ISO 8601-tidsstempel for når timen ble opprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for siste oppdatering. Kan være `null`.

**profile** `object` *required*

Pasientprofilen som er knyttet til denne timen.

**profil**

**id** `string`

Unik profilidentifikator (UUID).

**handle** `string`

Profil-handle eller brukernavn. Kan være `null`.

**first\_name** `string`

Fornavn. Kan være `null`.

**last\_name** `string`

Etternavn. Kan være `null`.

**email** `string`

E-postadresse. Kan være `null`.

**phone** `string`

Telefonnummer i E.164-format. Kan være `null`.

**sex** `integer`

Biologisk kjønn etter ISO/IEC 5218. Kan være `null`.

**date\_of\_birth** `string`

Fødselsdato i `YYYY-MM-DD`-format. Kan være `null`.

**height** `number`

Høyde i centimeter. Kan være `null`.

**weight** `number`

Vekt i kilogram. Kan være `null`.

**language** `string`

Foretrukket språk: en av de 32 kodene i [Opprett profil](https://docs.anivahealth.com/no/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Om denne profilen mottar transaksjonelle (programmatiske) e-poster. Kan være `null`.

**created\_at** `string`

ISO 8601-tidsstempel for når profilen ble opprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for siste profiloppdatering. Kan være `null`.

**panels** `AppointmentPanel[]` *required*

Paneler som for øyeblikket er knyttet til denne timen. Utelater kansellerte tilknytninger. Slå opp
paneldetaljer (navn, biomarkører) via [Vis paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**Felt for tilknyttet panel**

**panel\_id** `string`

Panel-UUID – kryssreferer mot [Vis paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstempel for når panelet først ble knyttet til denne timen.

**individual\_biomarkers** `AppointmentIndividualBiomarker[]` *required*

Enkeltbiomarkører knyttet til denne timen utenfor et panel (se [Legg til egendefinerte
biomarkører](https://docs.anivahealth.com/no/api/appointments/add-individual-biomarkers.md)). Kryssreferer hver `biomarker_id`
mot [Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) for visningsdata.

**Felt for enkeltbiomarkør**

**biomarker\_id** `integer`

Biomarkøridentifikator – kryssreferer mot
[Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

ISO 8601-tidsstempel for når biomarkøren først ble knyttet til denne timen.

**shipments** `AppointmentShipmentLink[]` *required*

Forsendelser knyttet til denne timen, med eldste kobling først. Tomt array når ingen forsendelser er
knyttet til. Slå opp hver `id` mot [Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md) for
fullstendige forsendelsesdata (status, sporingsnummer, statusoppdateringer osv.).

**Felt for forsendelseskobling**

**id** `string`

Referanseidentifikator for forsendelsen – kryssreferer mot
[Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for når forsendelsen først ble koblet til denne timen.

**lab\_codes** `string[]` *required*

Labkoder (strekkoder på prøverør) som er registrert for denne timen, i skannerekkefølge. Tom til blodprøvetakingen
er bekreftet. En venøs blodprøvetaking har én kode trykket på hvert prøverør; en kapillær blodprøvetaking har én
kode per mikrorør. Resultater og dokumenter i [Hent resultater](https://docs.anivahealth.com/no/api/appointments/get-results.md) refererer til
disse kodene via `lab_code`.

## Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor
denne tiden får det lagrede svaret. Headerne `Cache-Status` og `Age` viser at svaret er
lagret og hvor gammelt det er.

For å få beskjed om en endring med én gang, abonner på webhook-hendelsene `appointment.created`, `appointment.rescheduled` og hendelsen for hver status, for eksempel `appointment.confirmed`.
Se [Gjentatte lesinger](https://docs.anivahealth.com/no/concepts/webhooks.md#gjentatte-lesinger).

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldig spørreparameter, for eksempel en `date` som ikke er `YYYY-MM-DD`. |
| `403` | Forbudt — API-nøkkelen din har ikke tilgang til denne operasjonen, eller den forespurte profilen eller stedet er utenfor tilgangsområdet ditt. |
| `500` | Intern serverfeil. |

```bash cURL (all appointments) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (one day at one location) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/appointments?date=2026-10-21&location_id=b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b' \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (by profile) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/appointments?profile_id=a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T10:30:00Z",
    "status": "confirmed",
    "cancellation_reason": null,
    "results_ready_emails": [],
    "draw_method": "venous",
    "created_at": "2026-04-01T09:45:00Z",
    "updated_at": null,
    "profile": {
      "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
      "handle": null,
      "first_name": "Maria",
      "last_name": "Schmidt",
      "email": "maria.schmidt@example.com",
      "phone": "+4930123456789",
      "sex": 2,
      "date_of_birth": "1985-03-22",
      "height": 168,
      "weight": 65,
      "language": "de",
      "transactional_emails_enabled": true,
      "created_at": "2026-04-01T09:14:32Z",
      "updated_at": null
    },
    "panels": [
      {
        "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "added_at": "2026-04-01T09:50:00Z"
      }
    ],
    "individual_biomarkers": [
      {
        "biomarker_id": 42,
        "added_at": "2026-04-01T09:52:00Z"
      }
    ],
    "shipments": [
      {
        "id": "P2611194821",
        "added_at": "2026-04-15T07:00:00Z"
      }
    ],
    "lab_codes": []
  }
]
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


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