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

# Obtén la disponibilitat

> Recupera les hores d'inici de les franges reservables d'una sola ubicació

Retorna les hores d'inici de les franges reservables d'una sola ubicació dins l'interval sol·licitat.
Les franges es generen a partir de `open_hours` de la ubicació, ometent les dates bloquejades
globals / per ubicació i restant les cites d'Aniva ja reservades, de manera que el resultat
reflecteix el que els teus pacients poden reservar realment des del client.

Requereix l'àmbit `appointments_schedule`. La ubicació també ha d'estar inclosa dins el context d'accés de grups d'ubicacions de la teva clau d'API.

> [!NOTE]
>
> Fes servir aquest punt final en lloc de deduir la disponibilitat a partir dels valors estàtics de
> `open_hours` que retorna [Llista les ubicacions](https://docs.anivahealth.com/ca/api/locations/list-locations.md) — només aquest
> punt final té en compte les reserves en temps real, les excepcions d'horari per data i el
> [preavís mínim](https://docs.anivahealth.com/ca/api/appointments/create-appointment.md#antelacio-minima) de 12 hores a les ubicacions
> gestionades per Aniva. Cada franja retornada aquí es pot reservar tal qual.

Les respostes inclouen `Cache-Control: private, max-age=30, stale-while-revalidate=60`, de manera
que un navegador pot servir una càrrega útil en memòria cau durant fins a \~30 segons — una franja
reservada dins aquest interval encara pot aparèixer com a reservable fins a la pròxima actualització.
Mostra també els conflictes en el moment de fer la reserva.

## Paràmetres de ruta

**id** `string` *required*

Identificador de la ubicació (UUID). Fes servir l'`id` de [Llista les ubicacions](https://docs.anivahealth.com/ca/api/locations/list-locations.md).

## Paràmetres de consulta

**start\_date** `string`

Inici inclusiu de l'interval en format `YYYY-MM-DD` (interpretat en `timezone`). Opcional. Per
defecte és **avui** si no s'indica cap data, o **`end_date − 30 days`** si només s'indica
`end_date`. Les dates passades s'ajusten silenciosament a avui.

**end\_date** `string`

Final inclusiu de l'interval en format `YYYY-MM-DD` (interpretat en `timezone`). Opcional. Per
defecte és **avui + 30 dies** si no s'indica cap data, o **`start_date + 30 days`** si només
s'indica `start_date`. Ha de ser igual o posterior a `start_date` i dins els 90 dies següents a
avui.

**timezone** `string`

Zona horària IANA (p. ex., `Europe/Berlin`) utilitzada per interpretar `start_date` / `end_date` i
per agrupar les franges per data del calendari. Opcional — per defecte fa servir la zona horària
pròpia de la ubicació. Les hores d'inici de les franges sempre es mostren com a instants UTC (`Z`)
i no canvien mai amb aquest paràmetre — la graella de franges sempre es projecta des de la zona
horària de la ubicació; el paràmetre només afecta en quin dia del calendari s'agrupa una franja.
Les entrades de dia de la resposta cobreixen exactament `start_date`..`end_date` com a dies del
calendari en aquesta zona horària. Omet-lo tret que mostris el selector en una altra zona horària.

## Resposta

En cas d'èxit, l'API retorna `200 OK` amb un únic objecte de disponibilitat.

**location\_id** `string` *required*

Identificador de la ubicació reproduït.

**timezone** `string` *required*

Zona horària IANA en què es mostra la resposta (p. ex., `Europe/Berlin`) — reprodueix el paràmetre
de consulta `timezone` quan s'indica; en cas contrari, la zona horària pròpia de la ubicació.

**slot\_interval\_minutes** `integer`

Separació en minuts entre els inicis consecutius de franges reservables. És el pas de la graella
configurat a la ubicació — cada franja d'`availability` cau en aquesta graella. Només és `null`
quan la ubicació no té configuració d'horaris. **No és un interval de durada de la cita:** les
reserves superposades amb hores d'inici diferents no entren en conflicte; només les coincidències
d'inici exacte compten per a la concurrència.

**availability** `array` *required*

Franges reservables per dia. Els dies sense franges reservables s'ometen per mantenir la càrrega
útil compacta. Cada entrada té:

**entrada per dia**

**date** `string` *required*

Data del calendari en la `timezone` de la resposta (`YYYY-MM-DD`).

**slots** `array` *required*

Inicis de franja com a instants UTC (ISO 8601 amb el sufix `Z`), en ordre ascendent.

## Respostes d'error

| Estat | Descripció |
| - | - |
| `400` | ID d'ubicació no vàlid, format de data o zona horària no vàlid, `end_date` anterior a `start_date` o `end_date` més de 90 dies en el futur. |
| `403` | Prohibit — falta l'àmbit `appointments_schedule` o la ubicació és fora del teu context d'accés. |
| `404` | Ubicació no trobada o inactiva. |
| `500` | Error intern del servidor. |

```bash cURL theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/locations/b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b/availability?start_date=2026-05-01&end_date=2026-05-07' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
  "timezone": "Europe/Berlin",
  "slot_interval_minutes": 15,
  "availability": [
    {
      "date": "2026-05-04",
      "slots": ["2026-05-04T07:00:00Z", "2026-05-04T07:15:00Z", "2026-05-04T07:30:00Z"]
    },
    {
      "date": "2026-05-05",
      "slots": ["2026-05-05T06:00:00Z", "2026-05-05T06:15:00Z"]
    }
  ]
}
```


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