> ## 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 beställningar av hemtestkit

> Hämta självtestkit med hemleverans som din API-nyckel har åtkomst till

Hämta en lista över beställningar av hemtestkit. En beställning av hemtestkit skickar ett självtestkit hem med posten – Aniva skickar kitet, patienten tar provet själv hemma och skickar tillbaka det med posten. Varje beställning av hemtestkit innehåller den inbäddade patientprofilen.

När `profile_id` anges returneras alla beställningar av hemtestkit för den profilen. När det utelämnas returneras alla tillgängliga beställningar av hemtestkit.

Kräver behörigheten `home_kit_orders_view` eller `home_kit_orders_manage`.

## Förfrågan

### Frågeparametrar

**profile\_id** `string`

Filtrera på profilens UUID. När det anges returneras alla beställningar av hemtestkit för den här profilen.

**lab\_code** `string`

Filtrera på labbkod (exakt matchning) – koppla ett fysiskt kit i handen till dess beställning med koden
som står tryckt på det, t.ex. innan du anropar [Aktivera](https://docs.anivahealth.com/sv/api/home-kit-orders/activate-home-kit.md).

## Svar

Vid lyckat anrop returnerar API:et `200 OK` med en array av beställningsobjekt för hemtestkit.

**id** `string` *required*

Unik identifierare (UUID) för beställningen av hemtestkit.

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

UUID för profilen som den här beställningen av hemtestkit tillhör.

**status** `string` *required*

Aktuell status för beställningen av hemtestkit. Ett av värdena `pending`, `dispatched`, `activated` eller `cancelled`.
Detaljerad status för klara labbresultat får du från [Hämta resultat](https://docs.anivahealth.com/sv/api/home-kit-orders/get-results.md).

**delivery\_address** `object` *required*

Adressen som kitet ska skickas till – i ett av två format: antingen `{ location_id }` som refererar till en känd testplats, eller inline-adressfälten (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` är valfria – samma fältnamn som i locations-API:et). Ange exakt ett alternativ – en platsreferens eller en inline-adress, inte båda.

**leveransadress**

> [tab] Platsreferens
>
> **location\_id** `string` *required*
>
> UUID för testplatsen som kitet skickas till.

> [tab] Inline-adress
>
> **name** `string` *required*
>
> Mottagarens, företagets eller platsens namn.
>
> **company\_name** `string`
>
> Företag som tar emot paketet åt mottagaren – en `c/o`-mottagare eller en avdelning.
>
> **street** `string` *required*
>
> Gatunamn utan husnummer (t.ex. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (t.ex. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Byggnad, ingång eller våning.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valfritt.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kod (två bokstäver, t.ex. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratoriets provkod som resultaten rapporteras under – tryckt på det fysiska kitet, och det som
patienten läser av från lådan som aktiveringskod. `null` tills kitet är packat.
Skrivskyddad.

**activated\_at** `string` *required*

Tidsstämpel för provtagning rapporterad via [Aktivera](https://docs.anivahealth.com/sv/api/home-kit-orders/activate-home-kit.md) –
när patienten tog sitt prov. `null` tills kitet är aktiverat.

**replaces\_home\_kit\_order\_id** `string`

Beställningen av hemtestkit som den här ersätter, när det rör sig om ett ersättningskit. `null`
för en vanlig beställning. Se [Skapa beställning av hemtestkit](https://docs.anivahealth.com/sv/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Anledningen till att ersättningen skickades. `null` för en vanlig beställning.

**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).

**metadata** `object` *required*

Partnerdefinierade nyckel/värde-par som returneras exakt som de skickades. Finns alltid med – `{}`
när inga värden angetts.

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

ISO 8601-tidsstämpel för när beställningen av hemtestkit 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 beställningen av hemtestkit.

**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** `HomeKitOrderPanel[]` *required*

Panelen som är kopplad till denna beställning av hemtestkit – alltid exakt en (ett hemtestkit motsvarar 1:1 en
fysisk kitprodukt), och den kan bytas via [Uppdatera](https://docs.anivahealth.com/sv/api/home-kit-orders/update-home-kit.md) medan status är
`pending`. Slå upp paneldetaljer (namn, biomarkörer) via [Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**Fält för kopplad panel**

**panel\_id** `string`

Panel-UUID – stäm av 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 den här beställningen av hemtestkit.

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

Enskilda biomarkörer som är kopplade till denna beställning av hemtestkit utanför en panel. Stäm av varje
`biomarker_id` mot [Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md) med `home_kit=true` för visningsdata.

**Fält för enskild biomarkör**

**biomarker\_id** `integer`

Biomarköridentifierare – stäm av mot
[Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md) med `home_kit=true`.

**added\_at** `string`

ISO 8601-tidsstämpel för när biomarkören först kopplades till den här beställningen av hemtestkit.

**shipments** `HomeKitOrderShipmentLink[]` *required*

Paket kopplade till denna beställning av hemtestkit, äldsta kopplingen först – vanligtvis kitet till patienten
och provet tillbaka till laboratoriet. Tom tills lagret skriver ut en fraktetikett. Läs
fullständig paketinformation med [Lista försändelser](https://docs.anivahealth.com/sv/api/shipments/list-shipments.md) och `?home_kit_order_id=`.

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

**id** `string`

Försändelsereferens – stäm av 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 länkades till den här beställningen av hemtestkit.

## 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 kan du prenumerera på webhook-händelserna `home_kit_order.created` och händelsen för varje status, till exempel `home_kit_order.activated`.
Se [Upprepade läsningar](https://docs.anivahealth.com/sv/concepts/webhooks.md#upprepade-laesningar).

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Valideringsfel – till exempel om `profile_id` inte är en giltig UUID, eller om förfrågan har en okänd parameter. |
| `403` | Förbjudet – din API-nyckel har inte åtkomst till den här åtgärden, eller så ligger den begärda profilen utanför ditt behörighetsområde. |
| `500` | Internt serverfel. |

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

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

```json 200 theme={null}
[
  {
    "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "status": "dispatched",
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Friedrichstraße",
      "house_number": "123",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    },
    "created_at": "2026-04-01T09:45:00Z",
    "updated_at": "2026-04-02T08:00:00Z",
    "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"
      }
    ],
    "metadata": {},
    "replaces_home_kit_order_id": null,
    "replacement_reason": null,
    "results_ready_emails": [],
    "lab_code": "7642000123",
    "activated_at": null,
    "shipments": [
      { "id": "K2604021FQ7", "added_at": "2026-04-02T08:00:00Z" },
      { "id": "K260402P3XD", "added_at": "2026-04-02T08:00:00Z" }
    ]
  }
]
```

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