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

# Lista bokningar

> Hämta bokningar för blodprovstagning som din API-nyckel har åtkomst till

Hämta en lista över bokningar för blodprovstagning. Varje bokning innehåller den inbäddade patientprofilen.

Filtren kombineras:

* `date` returnerar bokningarna för en kalenderdag. Dagen är den lokala dagen för respektive boknings plats, så en blodprovstagning kl. 23:30 i Berlin räknas på sitt Berlin-datum.
* `location_id` returnerar bokningarna på en provtagningsplats.
* `profile_id` utan `date` returnerar alla bokningar för den profilen, utan tidsbegränsning.
* Utan `profile_id` och utan `date` gäller standardtidsfönstret: de senaste 2 månaderna till 1 månad framåt.

Kräver scopet `appointments_view` eller `appointments_schedule`.

## Förfrågan

### Frågeparametrar

**profile\_id** `string`

Filtrera efter profilens UUID. När det anges returneras alla bokningar för profilen oavsett
bokat datum. När det utelämnas gäller standardtidsfönstret.

**location\_id** `string`

Filtrera efter provtagningsplatsens UUID.

**date** `string`

Kalenderdag i formatet `YYYY-MM-DD`, i tidszonen för respektive boknings plats. Ersätter
standardtidsfönstret. Resultaten sorteras efter `scheduled_at`, tidigast först.

## Svar

Vid lyckat anrop returnerar API:et `200 OK` med en array med bokningsobjekt.

**id** `string` *required*

Unik identifierare för bokningen (UUID).

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

UUID för den profil som bokningen tillhör.

**location\_id** `string`

UUID för provtagningsstället där blodprovstagningen sker.

**scheduled\_at** `string`

Planerat datum och tid för bokningen i UTC (ISO 8601 med `Z`-suffix, t.ex.
`2026-05-15T10:30:00Z`). Kan vara `null`.

**status** `string` *required*

Aktuell bokningsstatus. Något av `pending`, `confirmed`, `blood_drawn` eller `cancelled`.
Detaljerad status för färdigställda labbresultat får du från [Hämta resultat](https://docs.anivahealth.com/sv/api/appointments/get-results.md);
mer detaljerad försändelsestatus från varje post i `shipments`-arrayen nedan vidare till [Hämta
försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md).

**cancellation\_reason** `string`

Orsak i fritext som registrerades när bokningen avbokades (t.ex. uteblivet besök, sen avbokning,
'Misslyckades. Behöver göras om'). `null` om inte `status` är `cancelled`.

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

Adresser som var och en får ett mejl när alla labbresultat är slutgiltiga, i gemener. Tom när funktionen är avstängd. Se
[Mejl när resultat är klara](https://docs.anivahealth.com/sv/concepts/results.md#mejl-naer-resultat-aer-klara).

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

Hur blodet tas: `capillary` (fingertopp eller överarm, i mikrorör) eller `venous` (från ven,
i provrör). Det är metoden som bokningen anger, annars `default_draw_method` för dess
[provtagningsställe](https://docs.anivahealth.com/sv/concepts/locations.md). Efter blodprovstagningen är det den metod som användes.

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

ISO 8601-tidsstämpel för när bokningen skapades.

**updated\_at** `string`

ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara `null`.

**profile** `object` *required*

Patientprofilen som är kopplad till den här bokningen.

**profil**

**id** `string`

Unik identifierare för profilen (UUID).

**handle** `string`

Profil-handle eller användarnamn. Kan vara `null`.

**first\_name** `string`

Förnamn. Kan vara `null`.

**last\_name** `string`

Efternamn. Kan vara `null`.

**email** `string`

E-postadress. Kan vara `null`.

**phone** `string`

Telefonnummer i E.164-format. Kan vara `null`.

**sex** `integer`

Biologiskt kön enligt ISO/IEC 5218. Kan vara `null`.

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

Födelsedatum i formatet `YYYY-MM-DD`. Kan vara `null`.

**height** `number`

Längd i centimeter. Kan vara `null`.

**weight** `number`

Vikt i kilogram. Kan vara `null`.

**language** `string`

Föredraget språk: en av de 32 koderna i [Skapa profil](https://docs.anivahealth.com/sv/api/profiles/create-profile.md).

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

Om profilen tar emot transaktionella (programmatiska) mejl. Kan vara `null`.

**created\_at** `string`

ISO 8601-tidsstämpel för när profilen skapades.

**updated\_at** `string`

ISO 8601-tidsstämpel för den senaste uppdateringen av profilen. Kan vara `null`.

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

Paneler som för närvarande är kopplade till den här bokningen. Exkluderar avbrutna kopplingar. Slå upp
paneldetaljer (namn, biomarkörer) via [Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**Fält för kopplade paneler**

**panel\_id** `string`

Panelens UUID — korsreferera mot [Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när panelen först kopplades till bokningen.

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

Enskilda biomarkörer som är kopplade till den här bokningen utanför någon panel (se [Lägg till anpassade
biomarkörer](https://docs.anivahealth.com/sv/api/appointments/add-individual-biomarkers.md)). Korsreferera varje `biomarker_id`
mot [Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md) för visningsdata.

**Fält för enskilda biomarkörer**

**biomarker\_id** `integer`

Identifierare för biomarkören — korsreferera mot
[Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när biomarkören först kopplades till bokningen.

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

Försändelser kopplade till den här bokningen, med den äldsta kopplingen först. Tom array när inga försändelser är
kopplade. Jämför varje `id` mot [Hämta försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md) för hela
försändelsens payload (status, spårningsnummer, statusuppdateringar osv.).

**Fält för försändelselänkar**

**id** `string`

Referensidentifierare för försändelsen — korsreferera mot
[Hämta försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när försändelsen först länkades till bokningen.

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

Labbkoder (rörens streckkoder) som registrerats för den här bokningen, i skanningsordning. Tom tills blodprovstagningen
är bekräftad. En venös blodprovstagning har en kod tryckt på varje provrör; en kapillär blodprovstagning har en
kod per mikrorör. Resultat och dokument i [Hämta resultat](https://docs.anivahealth.com/sv/api/appointments/get-results.md) refererar till
dessa koder via `lab_code`.

## Upprepade anrop

Aniva lagrar svaret från den här slutpunkten i 5 minuter per API-nyckel. Ett upprepat anrop inom
den tiden får det lagrade svaret. Headerna `Cache-Status` och `Age` visar att svaret är
lagrat och hur gammalt det är.

För att få reda på en ändring direkt, prenumerera på webhook-händelserna `appointment.created`, `appointment.rescheduled` och händelsen för varje status, till exempel `appointment.confirmed`.
Se [Upprepade läsningar](https://docs.anivahealth.com/sv/concepts/webhooks.md#upprepade-laesningar).

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Ogiltig frågeparameter, till exempel ett `date` som inte har formatet `YYYY-MM-DD`. |
| `403` | Åtkomst nekad – din API-nyckel har inte behörighet till den här åtgärden, eller så ligger den begärda profilen eller platsen utanför ditt behörighetsområde. |
| `500` | Internt serverfel. |

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