# Health check

Operation ID: `appointments.connect`

Check whether the Appointments API is reachable and identify the serving environment. No authentication is required.

## Public method

`connect`

Signature: `appointments.connect()`

Return type: `Promise<ConnectResponse>`

## Authentication

Classification: **PUBLIC**

## Prerequisites

None documented.

## HTTP

`GET /connect`

## Path parameters

None.

## Query parameters

None.

## Body parameters

None.

Request model: None.

## Request example

None declared in canonical OpenAPI.

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`ConnectivityResponse`](../models/ConnectivityResponse.md) | application/json | Appointments API connectivity status |

## Success response examples

### 200 — Appointments API is reachable

```json
{
  "environment": "dev",
  "service": "appointments-api",
  "status": "connected"
}
```

## Common errors

None declared in canonical OpenAPI.

## Error examples

None declared in canonical OpenAPI.

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
```

```ts
const result = await appointments.connect();
```

## cURL

```bash
curl -X GET \
  'https://dev-api-appointments.health.cloud/connect'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.