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

> Listaa potilasprofiilit tai hae niitä sähköpostiosoitteella

Listaa API-avaimesi käytettävissä olevat potilasprofiilit tai hae yksittäinen profiili tarkalla sähköpostiosoitteella.

Kun `email` annetaan, päätepiste tekee Redis-välimuistitetun tarkan haun
varsinaisesta kirjautumissähköpostiosoitteesta ja palauttaa 0 tai 1 tulosta; `limit`- ja `offset`-parametrit ohitetaan tällöin.
Kun se jätetään pois, päätepiste palauttaa sivutetun listan profiileista API-avaimesi
käyttöoikeusalueen mukaan rajattuna.

Sähköpostin täsmäys on kirjainkoosta riippumaton ja tarkka — osamerkkijono- ja etuliitehakuja ei tueta.
Vain varsinainen kirjautumissähköpostiosoite tarkistetaan; vaihtoehtoisia osoitteita, kuten `work_email`, ei
huomioida.

Vaatii `profiles_view`- tai `impersonate`-käyttöoikeuden.

## Pyyntö

### Kyselyparametrit

**email** `string`

Suodata tarkan sähköpostiosoitteen mukaan (kirjainkoosta riippumaton). Kun arvo on asetettu, palauttaa 0 tai 1 tulosta ja
`limit`/`offset` ohitetaan. Haku palvellaan Redis-välimuistitetusta käänteisindeksistä, ja varajärjestelmänä toimii
indeksoitu SQL-haku.

**limit** `integer` (default: 100)

Palautettavien profiilien enimmäismäärä. Oletus on 100, enimmäismäärä 500. Ohitetaan, kun `email` on asetettu.

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

Sivutusta varten ohitettavien profiilien määrä. Oletus on 0. Ohitetaan, kun `email` on asetettu.

## Vastaus

Onnistuessaan API palauttaa tilan `200 OK` ja taulukon profiiliobjekteja. Kunkin
alkion rakenne vastaa [Hae profiili](https://docs.anivahealth.com/fi/api/profiles/get-profile.md) -päätepistettä.

**id** `string` *required*

Profiilin yksilöllinen tunniste (UUID).

**handle** `string`

Profiilin nimimerkki tai käyttäjätunnus. Voi olla `null`.

**first\_name** `string`

Etunimi. Voi olla `null`.

**last\_name** `string`

Sukunimi. Voi olla `null`.

**email** `string`

Sähköpostiosoite. Voi olla `null`.

**phone** `string`

Puhelinnumero E.164-muodossa. Voi olla `null`.

**sex** `integer`

Biologinen sukupuoli ISO/IEC 5218 -standardin mukaan (`0` = tuntematon, `1` = mies, `2` = nainen). Voi olla `null`.

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

Syntymäaika `YYYY-MM-DD`-muodossa. Voi olla `null`.

**height** `number`

Pituus senttimetreinä. Voi olla `null`.

**weight** `number`

Paino kilogrammoina. Voi olla `null`.

**language** `string`

Ensisijainen kieli: `en`, `bg`, `ca`, `cs`, `da`, `de`, `el`, `es`, `et`, `fi`, `fr`, `ga`, `hr`, `hu`, `is`, `it`, `lb`, `lt`, `lv`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, `tr` tai `uk`.

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

Vastaanottaako profiili tapahtumapohjaisia (ohjelmallisia) sähköposteja. `null`, jos arvoa ei ole koskaan asetettu.

**created\_at** `string`

ISO 8601 -aikaleima profiilin luontihetkestä.

**updated\_at** `string`

ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla `null`.

## Huomioita toiminnasta

* Tyhjä taulukko palautetaan sekä silloin, kun yksikään profiili ei vastaa sähköpostia, että silloin, kun osuma on
  käyttöoikeusalueesi ulkopuolella. Tämä on tarkoituksellista — se estää päätepistettä paljastamasta
  sellaisten profiilien olemassaoloa, joita et voi lukea.
* Vasta luodut profiilit ovat heti haettavissa `email`-osoitteella, koska luontiprosessi
  päivittää välimuistin synkronisesti.
* Suodattamaton lista on järjestetty `created_at`-kentän mukaan laskevasti (uusin ensin) ja sivutettu
  `limit`- ja `offset`-parametreilla.

## Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 5 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä
tehty toistuva kutsu saa tallennetun vastauksen. Otsikot `Cache-Status` ja `Age` kertovat, että vastaus on
tallennettu ja kuinka vanha se on.

Saat tiedon muutoksista heti tilaamalla webhook-tapahtumat `profile.created`, `profile.updated` ja `profile.deleted`.
Katso [Toistuvat lukupyynnöt](https://docs.anivahealth.com/fi/concepts/webhooks.md#toistuvat-haut).

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe — virheellinen sähköpostimuoto tai `limit`/`offset` sallitun alueen ulkopuolella. |
| `403` | Kielletty — API-avaimellasi ei ole vaadittua käyttöoikeutta (`profiles_view`/`impersonate`). |
| `500` | Palvelimen sisäinen virhe. |

```bash cURL (lookup by email) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (paginated list) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "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": "2026-04-01T11:05:00Z"
  }
]
```

```json 200 (no match) theme={null}
[]
```

```json 400 theme={null}
{
  "error": "email: Invalid email format"
}
```


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